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 5 commits into
base: main
Choose a base branch
from
Draft

Vitepress build #2490

wants to merge 5 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 (happens in a few places where things like <someobject> are in a description outside of a code block. Maybe just fix the instances - can be found in Vitepress test branch MAVSDK-docs#292
  • Make api ref docs in CI build into github docs tree - annoying to have build artifacts in repo but safer.
  • Add access token for CI - done
  • Test workflow action for building. Make sure reference builds before main docs
  • Disable old repo

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

yarn install
yarn start

Then view in browser.

Copy link

sonarqubecloud bot commented Jan 3, 2025

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.

1 participant