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

Merged
merged 20 commits into from
Jan 29, 2025
Merged

Vitepress build #2490

merged 20 commits into from
Jan 29, 2025

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 - done as post process in Fix notes tips warnings in docs #2501
  • 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!

.github/workflows/docs_deploy.yml Outdated Show resolved Hide resolved
.github/workflows/docs_deploy.yml Outdated Show resolved Hide resolved
.gitignore Outdated Show resolved Hide resolved
docs/.vitepress/config.mjs Show resolved Hide resolved
@hamishwillee hamishwillee marked this pull request as ready for review January 28, 2025 22:46
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.

Let's try it!

@julianoes julianoes merged commit 1a25c9c into main Jan 29, 2025
41 checks passed
@julianoes julianoes deleted the vitepress_build branch January 29, 2025 00:09
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