Skip to content

refactor: move docs from cpp/docs/ to docs/ at repo root#2845

Open
bansiesta wants to merge 1 commit into
mavlink:mainfrom
bansiesta:move-docs-to-root
Open

refactor: move docs from cpp/docs/ to docs/ at repo root#2845
bansiesta wants to merge 1 commit into
mavlink:mainfrom
bansiesta:move-docs-to-root

Conversation

@bansiesta
Copy link
Copy Markdown
Collaborator

Summary

  • Move VitePress docs site from cpp/docs/ to docs/ at the repo root, since docs now cover more than just C++ (Python, Swift, etc.)
  • Update docs_deploy.yml CI workflow paths, working-directory, and artifact path
  • Update path filters in linux.yml, macos.yml, windows.yml, fuzzing.yml
  • Update .gitignore entries for node_modules, cache, and dist
  • Update README.md references
  • Update VitePress edit-on-GitHub links

Note: cpp/tools/generate_docs.sh already referenced ../docs/ so no change needed there.

Test plan

  • CI docs build passes with new path
  • VitePress edit links point to correct GitHub path

🤖 Generated with Claude Code

@bansiesta bansiesta force-pushed the move-docs-to-root branch from 1c6cc98 to b0d650e Compare April 6, 2026 00:38
@julianoes julianoes requested a review from hamishwillee April 7, 2026 21:29
julianoes
julianoes previously approved these changes Apr 7, 2026
Copy link
Copy Markdown
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 out. Actually, let me build it locally and see how it looks first.

@julianoes julianoes mentioned this pull request Apr 12, 2026
6 tasks
@hamishwillee
Copy link
Copy Markdown
Collaborator

Ping me when you really want a review, with some expectations - i.e. you just want a sanity check of the concept or whatever.

@julianoes
Copy link
Copy Markdown
Collaborator

Thanks @hamishwillee. What's missing is the overall docs explaining what this is, how we move forward with the new Python wrappers, etc.

Comment thread docs/en/index.md
- [MAVSDK-CSharp](https://github.com/mavlink/MAVSDK-CSharp) (2019): Proof of concept.
- [MAVSDK-Rust](https://github.com/mavlink/MAVSDK-Rust) (2019): Proof of concept.

## New Python Wrappers (`mavsdk` and `aiomavsdk`)
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@JonasVautherin we need to go through this.

Moves all documentation from cpp/docs/ to docs/ at the repository root.
Updates CI workflows, .gitignore, README, and generate_docs.sh accordingly.
Adds Python API reference docs for mavsdk and aiomavsdk.
@bansiesta bansiesta force-pushed the move-docs-to-root branch from 6fb81e8 to ce99e5b Compare May 26, 2026 05:27
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.

3 participants