Skip to content

Commit b0d650e

Browse files
bansiestaclaude
andcommitted
refactor: move docs from cpp/docs/ to docs/ at repo root
The docs cover more than just C++ (Python, Swift, etc.), so move the VitePress site to the repo root level. Update CI workflows (docs_deploy.yml, linux.yml, macos.yml, windows.yml, fuzzing.yml), .gitignore, README, and VitePress edit-on-GitHub links accordingly. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 84d718a commit b0d650e

383 files changed

Lines changed: 13209 additions & 25 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/docs_deploy.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ on:
88
#tags:
99
# - 'v*'
1010
paths:
11-
- 'cpp/docs/**'
11+
- 'docs/**'
1212
pull_request:
1313
paths:
14-
- 'cpp/docs/**'
14+
- 'docs/**'
1515

1616
workflow_dispatch:
1717

@@ -35,13 +35,13 @@ jobs:
3535
node-version: 20
3636
cache: npm
3737
# Specify the path to lock file for correct caching
38-
cache-dependency-path: ./cpp/docs/yarn.lock
38+
cache-dependency-path: ./docs/yarn.lock
3939

4040
- name: Install dependencies
41-
run: yarn install --frozen-lockfile --cwd ./cpp/docs
41+
run: yarn install --frozen-lockfile --cwd ./docs
4242

4343
- name: Build with VitePress
44-
working-directory: ./cpp/docs
44+
working-directory: ./docs
4545
run: |
4646
npm run docs:build
4747
touch .vitepress/dist/.nojekyll
@@ -50,7 +50,7 @@ jobs:
5050
uses: actions/upload-artifact@v7
5151
with:
5252
name: mavsdk_docs_build
53-
path: cpp/docs/.vitepress/dist/
53+
path: docs/.vitepress/dist/
5454
retention-days: 1
5555

5656
deploy:

.github/workflows/fuzzing.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ on:
55
branches:
66
- 'main'
77
paths-ignore:
8-
- 'cpp/docs/**'
8+
- 'docs/**'
99
pull_request:
1010
branches:
1111
- '*'
1212
paths-ignore:
13-
- 'cpp/docs/**'
13+
- 'docs/**'
1414

1515
concurrency:
1616
group: ${{ github.workflow }}-${{ github.ref }}

.github/workflows/linux.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ on:
77
tags:
88
- 'v*'
99
paths-ignore:
10-
- 'cpp/docs/**'
10+
- 'docs/**'
1111
pull_request:
1212
branches:
1313
- '*'
1414
paths-ignore:
15-
- 'cpp/docs/**'
15+
- 'docs/**'
1616
- '.github/workflows/docs_deploy.yml'
1717
workflow_dispatch:
1818

.github/workflows/macos.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ on:
77
tags:
88
- 'v*'
99
paths-ignore:
10-
- 'cpp/docs/**'
10+
- 'docs/**'
1111
pull_request:
1212
branches:
1313
- '*'
1414
paths-ignore:
15-
- 'cpp/docs/**'
15+
- 'docs/**'
1616
- '.github/workflows/docs_deploy.yml'
1717

1818
concurrency:

.github/workflows/windows.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ on:
77
tags:
88
- 'v*'
99
paths-ignore:
10-
- 'cpp/docs/**'
10+
- 'docs/**'
1111
pull_request:
1212
branches:
1313
- '*'
1414
paths-ignore:
15-
- 'cpp/docs/**'
15+
- 'docs/**'
1616
- '.github/workflows/docs_deploy.yml'
1717

1818
concurrency:

.gitignore

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ mavlink-headers
3131

3232

3333
# vitepress - Docs guide
34-
cpp/docs/node_modules/
35-
cpp/docs/.vitepress/cache/
36-
cpp/docs/.vitepress/dist/
34+
docs/node_modules/
35+
docs/.vitepress/cache/
36+
docs/.vitepress/dist/
3737

3838
# Fuzzing
3939
fuzz_corpus

README.md

Lines changed: 2 additions & 2 deletions

cpp/docs/en/python/index.md

Lines changed: 0 additions & 4 deletions
This file was deleted.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ export default defineConfig({
3232
pattern: ({ filePath, frontmatter }) => {
3333
if (frontmatter.newEditLink) {
3434
//newEditLink defines a frontmatter key you can use to append a path to main
35-
return `https://github.com/mavlink/MAVSDK/edit/main/cpp/docs/${frontmatter.newEditLink}`;
35+
return `https://github.com/mavlink/MAVSDK/edit/main/docs/${frontmatter.newEditLink}`;
3636
} else {
37-
return `https://github.com/mavlink/MAVSDK/edit/main/cpp/docs/${filePath}`;
37+
return `https://github.com/mavlink/MAVSDK/edit/main/docs/${filePath}`;
3838
}
3939
},
4040
text: "Edit on GitHub",

0 commit comments

Comments
 (0)