Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Vitepress build #2490

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from
Draft

Vitepress build #2490

wants to merge 12 commits into from

Conversation

hamishwillee
Copy link
Collaborator

@hamishwillee hamishwillee commented Jan 3, 2025

This is vitepress build from mavlink/MAVSDK-docs#292 adjusted to deploy from MAVSDK repo. It adds the docs to build into /docs/ tree.

Still to do

  • Fix up notes, tips, warnings
  • Check/Fix the script for generating references so it doesn't have any cases of HTML element tags - looks OK
  • Add access token for CI - done
  • Test workflow action for building.
  • Disable old repo

Not doing

  • Make api ref docs in CI build into github docs tree (Julian to sort)

This can be tested locally by cloning, then from root doing:

yarn install
yarn start

Then view in browser.

Copy link
Collaborator

@julianoes julianoes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few small comments. I think this will be good, thanks for that!


jobs:
build:
runs-on: ubuntu-latest
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
runs-on: ubuntu-latest
runs-on: ubuntu-24.04

I like to pin them, so they don't change from under you.

Comment on lines +34 to +35
- name: Install dependencies
run: yarn install --frozen-lockfile
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we move the package.json, package-lock.json and yarn.lock files into docs? I'd like not to "pollute" the root if possible.



# vitepress - Docs guide
node_modules/
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be nice if we can move the node_modules into docs.

Comment on lines +151 to +154
{
text: "v2",
link: "https://mavsdk.mavlink.io/v2.0/en/cpp/api_changes.html",
},
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will create v3 and we should add it here, because main won't be v3 forever.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants