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

Move PX4 Guide source into /docs #24490

Merged
merged 17 commits into from
Mar 13, 2025
Merged

Move PX4 Guide source into /docs #24490

merged 17 commits into from
Mar 13, 2025

Conversation

hamishwillee
Copy link
Contributor

@hamishwillee hamishwillee commented Mar 12, 2025

This is first steps to moving docs into PX4-Autopilot tree:

  • Vitepress
    • Copy in core folders
  • Github
    • .gitignore - done in subtree
    • .gitattributes - may be problem - sources currently have CRLF.
  • Source for docs
  • Workflows
    • Stop PX4 build/test workflows running for docs/ path
    • Crowdin upload/download
    • Flaw checker
    • Docs deploy
    • Add the required secrets to allow deployment, if needed
  • Add doc source

@mrpollo Trying to get some last minute PRs before I push this in. Two things worth looking at now, and we could push this in early:

  • Confirm you are OK with having this in /docs path. After all, there is a Documentation folder.
  • Worth looking at the workflow changes I have made to existing PX4 workflows just to confirm they make sense to you. Once those are in will reduce the churn made as I extend/test this.

]
},

"versions": {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We still need this while we have legacy gitbook in play - it provides the default version switcher options. Would love to have this same approach for vitepress. There's a plugin that does similar, but I don't trust it.

@mrpollo mrpollo force-pushed the pr_hw_move_docs_in_tree branch 2 times, most recently from daf4f2f to 48c4446 Compare March 12, 2025 22:45
@mrpollo mrpollo force-pushed the pr_hw_move_docs_in_tree branch from 48c4446 to ce9f5cf Compare March 12, 2025 22:46
Signed-off-by: Ramon Roche <[email protected]>
@mrpollo
Copy link
Contributor

mrpollo commented Mar 13, 2025

Great work, @hamishwillee. I like the setup; I made minor changes to the ci workflow files and can't wait to have the docs here!

@hamishwillee
Copy link
Contributor Author

Merging sources - let's get this building (now sources are present, even viewing this PR is impossible). I'll test the integration after.

@hamishwillee hamishwillee merged commit 88d623b into main Mar 13, 2025
14 of 61 checks passed
@hamishwillee hamishwillee deleted the pr_hw_move_docs_in_tree branch March 13, 2025 05:08
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