Move PX4 Guide source into /docs (#24490)

* Add vitepress tree

* Update existing workflows so they dont trigger on changes in the docs path

* Add nojekyll, package.json, LICENCE etc

* Add crowdin docs upload/download scripts

* Add docs flaw checker workflows

* Used docs prefix for docs workflows

* Crowdin obvious fixes

* ci: docs move to self hosted runner

runs on a beefy server for faster builds

Signed-off-by: Ramon Roche <mrpollo@gmail.com>

* ci: don't run build action for docs or ci changes

Signed-off-by: Ramon Roche <mrpollo@gmail.com>

* ci: update runners

Signed-off-by: Ramon Roche <mrpollo@gmail.com>

* Add docs/en

* Add docs assets and scripts

* Fix up editlinks to point to PX4 sources

* Download just the translations that are supported

* Add translation sources for zh, uk, ko

* Update latest tranlsation and uorb graphs

* update vitepress to latest

---------

Signed-off-by: Ramon Roche <mrpollo@gmail.com>
Co-authored-by: Ramon Roche <mrpollo@gmail.com>

.gitattributes

@@ -72,6 +72,7 @@ Makefile.* text eol=lf
 *.tar    binary
 *.tgz    binary
 *.zip    binary
+*.hex    binary
 
 # everything else
 .gitattributes text eol=lf

.github/workflows/build_all_targets.yml

@@ -14,9 +14,15 @@ on:
       - 'stable'
       - 'beta'
       - 'release/**'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
   pull_request:
     branches:
       - '*'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
 
 jobs:
   group_targets:

.github/workflows/checks.yml

@@ -4,9 +4,15 @@ on:
   push:
     branches:
     - 'main'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
   pull_request:
     branches:
     - '*'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
 
 jobs:
   build:

.github/workflows/clang-tidy.yml

@@ -4,10 +4,15 @@ on:
   push:
     branches:
     - 'main'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
   pull_request:
     branches:
     - '*'
-
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
 jobs:
   build:
     runs-on: ubuntu-latest

.github/workflows/compile_macos.yml

@@ -4,9 +4,15 @@ on:
   push:
     branches:
     - 'main'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
   pull_request:
     branches:
     - '*'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
 
 jobs:
   build:

.github/workflows/compile_ubuntu.yml

@@ -7,9 +7,15 @@ on:
       - 'stable'
       - 'beta'
       - 'release/**'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
   pull_request:
     branches:
       - '*'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
 
 jobs:
   build_and_test:

.github/workflows/dev_container.yml

@@ -10,9 +10,15 @@ on:
       - 'release/**'
     tags:
       - 'v*'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
   pull_request:
     branches:
       - '*'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
 
 jobs:
   build:

.github/workflows/docs_crowdin_download.yml

@@ -0,0 +1,50 @@
+name: Docs - Crowdin - Download Guide Translations
+
+# https://github.com/crowdin/github-action/tree/master
+
+on:
+  schedule:
+    - cron: '0 0 * * 0' # Runs every Sunday at 00:00 UTC
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  synchronize-with-crowdin:
+    name: Synchronize with Crowdin
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      max-parallel: 1 # Should be 1 to avoid parallel builds
+      matrix:
+        lc: [ko, uk, zh] # Target languages https://developer.crowdin.com/language-codes/
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Matrix
+        uses: crowdin/github-action@v2
+        with:
+          config: 'docs/crowdin.yml'
+          upload_sources: false
+          upload_translations: false
+          download_translations: true
+          commit_message: New Crowdin translations - ${{ matrix.lc }}
+          localization_branch_name: l10n_crowdin_docs_translations_${{ matrix.lc }}
+          crowdin_branch_name: main
+          create_pull_request: true
+          pull_request_base_branch_name: 'main'
+          pull_request_title: New PX4 guide translations (Crowdin) - ${{ matrix.lc }}
+          pull_request_body: 'New PX4 guide Crowdin translations by [Crowdin GH Action](https://github.com/crowdin/github-action) for ${{ matrix.lc }}'
+          download_language: ${{ matrix.lc }}
+        env:
+          # A classic GitHub Personal Access Token with the 'repo' scope selected (the user should have write access to the repository).
+          GITHUB_TOKEN: ${{ secrets.PX4BUILDBOT_ACCESSTOKEN }}
+
+          # A numeric ID, found at https://crowdin.com/project/<projectName>/tools/api
+          CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_DOCS_PROJECT_ID }}
+
+          # Visit https://crowdin.com/settings#api-key to create this token
+          CROWDIN_PERSONAL_TOKEN: ${{ secrets.PX4BUILDBOT_CROWDIN_PERSONAL_TOKEN }}

.github/workflows/docs_crowdin_upload.yml

@@ -0,0 +1,44 @@
+name: Docs - Crowdin - Upload Guide sources (en)
+
+# https://github.com/crowdin/github-action/tree/master
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/en/**'
+  pull_request:
+    types:
+      - closed
+    branches:
+      - main
+    paths:
+      - 'docs/en/**'
+  workflow_dispatch:
+
+jobs:
+  upload-to-crowdin:
+    if: github.event.pull_request.merged == true || github.event_name == 'push'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: crowdin push
+        uses: crowdin/github-action@v2
+        with:
+          config: 'docs/crowdin.yml'
+          upload_sources: true
+          upload_translations: false
+          download_translations: false
+          crowdin_branch_name: main
+        env:
+          # A classic GitHub Personal Access Token with the 'repo' scope selected (the user should have write access to the repository).
+          GITHUB_TOKEN: ${{ secrets.PX4BUILDBOT_ACCESSTOKEN }}
+
+          # A numeric ID, found at https://crowdin.com/project/<projectName>/tools/api
+          CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_DOCS_PROJECT_ID }}
+
+          # Visit https://crowdin.com/settings#api-key to create this token
+          CROWDIN_PERSONAL_TOKEN: ${{ secrets.PX4BUILDBOT_CROWDIN_PERSONAL_TOKEN }}

.github/workflows/docs_deploy.yml

@@ -0,0 +1,96 @@
+name: Docs - Deploy PX4 User Guide
+
+on:
+  push:
+    branches:
+      - 'main'
+      - 'release/**'
+    tags:
+      - 'v*'
+    paths:
+      - 'docs/en/**'
+  pull_request:
+    branches:
+      - '*'
+    paths:
+      - 'docs/en/**'
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+env:
+  BRANCH_NAME: ${{ github.head_ref || github.ref_name }}
+
+jobs:
+  build:
+    runs-on: [runs-on,runner=8cpu-linux-x64,image=ubuntu24-full-x64,"run-id=${{ github.run_id }}",spot=false,extras=s3-cache]
+    steps:
+      - uses: runs-on/action@v1
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+          # Specify the path to lock file for correct caching
+          cache-dependency-path: ./docs/yarn.lock
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile --cwd ./docs
+
+      - name: Build with VitePress
+        working-directory: ./docs
+        run: |
+          npm run docs:build_ubuntu
+          touch .vitepress/dist/.nojekyll
+          npm run docs:sitemap
+
+      - name: Upload artifact
+        if: ${{ github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.pull_request.merged) || github.event_name == 'workflow_dispatch' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: px4_docs_build
+          path: docs/.vitepress/dist/
+          retention-days: 1
+
+  deploy:
+    if: ${{ github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.pull_request.merged) || github.event_name == 'workflow_dispatch' }}
+    needs: build
+    runs-on: [runs-on,runner=2cpu-linux-x64,image=ubuntu24-full-x64,"run-id=${{ github.run_id }}",spot=false]
+
+    steps:
+      - name: Download Artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: px4_docs_build
+          path: ~/_book
+
+      - name: Deploy
+        run: |
+          git clone --single-branch --branch main https://${{ secrets.PX4BUILTBOT_PERSONAL_ACCESS_TOKEN }}@github.com/PX4/docs.px4.io.git
+          rm -rf docs.px4.io/${BRANCH_NAME}
+          mkdir -p docs.px4.io/${BRANCH_NAME}
+          cp -r ~/_book/* docs.px4.io/${BRANCH_NAME}/
+          cd docs.px4.io
+          git config --global user.name "${{ secrets.PX4BUILDBOT_USER }}"
+          git config --global user.email "${{ secrets.PX4BUILDBOT_EMAIL }}"
+          git add ${BRANCH_NAME}
+          git commit -a -m "PX4 docs build update (vitepress) `date`"
+          #git add .
+          #git commit --amend -m "PX4 docs build update (vitepress) `date`"
+          #git commit --allow-empty -m "Empty commit to force rebuild"
+          git push origin main -f

.github/workflows/docs_flaw_checker.yml

@@ -0,0 +1,74 @@
+name: Docs - Check for flaws in PX4 Guide Source
+# So far:
+  # Modifications of translations files
+  # Broken internal links
+
+on:
+  pull_request_target:
+    types: [opened, edited, synchronize]
+    paths:
+      - 'docs/en/**'
+
+jobs:
+  check_flaws:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Install Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+
+      - name: Create logs directory
+        run: |
+          mkdir logs
+
+      - name: Get changed english files
+        id: get_changed_markdown_english
+        uses: tj-actions/changed-files@v35.9.2
+        with:
+          json: true
+          base_sha: "${{ github.event.pull_request.base.sha }}"
+          sha: "${{ github.event.pull_request.head.sha }}"
+          # Below are used to output files to a directory. May use in flaw checker.
+          # write_output_files: true
+          # output_dir: "./logs"
+          files: |
+            docs/en/**/*.md
+
+      - name: Save JSON file containing files to link check
+        run: |
+          echo "${{ steps.get_changed_markdown_english.outputs.all_changed_files }}"
+          echo "${{ steps.get_changed_markdown_english.outputs.all_changed_files }}" > ./logs/prFiles.json
+
+      - name: Run link checker
+        id: link-check
+        run: |
+          npm -g install markdown_link_checker_sc@0.0.134
+          markdown_link_checker_sc -r ${{ github.workspace }} -d en -f ./docs/logs/prFiles.json -i assets -u docs.px4.io/main/ > ./docs/logs/errorsFilteredByPrPages.md
+          mkdir -p ./pr
+          cp ./docs/logs/errorsFilteredByPrPages.md ./pr/errorsFilteredByPrPages.md
+
+      - name: Read errorsFilteredByPrPages.md file
+        id: read-errors-by-page
+        uses: juliangruber/read-file-action@v1
+        with:
+          path: ./logs/errorsFilteredByPrPages.md
+
+      - name: Echo Errors by Page
+        run: echo "${{ steps.read-errors-by-page.outputs.content }}"
+
+      - name: Save PR number
+        env:
+          PR_NUMBER: ${{ github.event.number }}
+        run: |
+          #mkdir -p ./pr
+          echo $PR_NUMBER > ./pr/pr_number
+      - uses: actions/upload-artifact@v4
+        with:
+          name: pr_number
+          path: pr/

.github/workflows/ekf_functional_change_indicator.yml

@@ -4,6 +4,9 @@ on:
   pull_request:
     branches:
     - '*'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
 
 jobs:
   unit_tests:

.github/workflows/ekf_update_change_indicator.yml

@@ -1,6 +1,10 @@
 name: EKF Update Change Indicator
 
-on: push
+on:
+  push:
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
 
 jobs:
   unit_tests:

.github/workflows/failsafe_sim.yml

@@ -4,9 +4,15 @@ on:
   push:
     branches:
     - 'main'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
   pull_request:
     branches:
     - '*'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
 
 jobs:
   build:

.github/workflows/flash_analysis.yml

@@ -9,9 +9,15 @@ on:
   push:
     branches:
       - 'main'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
   pull_request:
     branches:
       - '*'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
 
 env:
   MIN_FLASH_POS_DIFF_FOR_COMMENT: 50

.github/workflows/mavros_mission_tests.yml

@@ -4,9 +4,15 @@ on:
   push:
     branches:
     - 'main'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
   pull_request:
     branches:
     - '*'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
 
 jobs:
   build:

.github/workflows/mavros_offboard_tests.yml

@@ -4,9 +4,15 @@ on:
   push:
     branches:
     - 'main'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
   pull_request:
     branches:
     - '*'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
 
 jobs:
   build:

.github/workflows/nuttx_env_config.yml

@@ -4,9 +4,15 @@ on:
   push:
     branches:
     - 'main'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
   pull_request:
     branches:
     - '*'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
 
 jobs:
   build:

.github/workflows/pr_comment.yml

@@ -0,0 +1,107 @@
+name: Docs - Comment Workflow
+on:
+  workflow_run:
+    workflows: ["Check for flaws"]
+    types:
+      - completed
+jobs:
+  comment:
+    permissions:
+      pull-requests: write # for marocchino/sticky-pull-request-comment
+    name: Comments
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Download PR artifact'
+        uses: actions/github-script@v6
+        with:
+          script: |
+            let allArtifacts = await github.rest.actions.listWorkflowRunArtifacts({
+               owner: context.repo.owner,
+               repo: context.repo.repo,
+               run_id: context.payload.workflow_run.id,
+            });
+            let matchArtifact = allArtifacts.data.artifacts.filter((artifact) => {
+              return artifact.name == "pr_number"
+            })[0];
+            let download = await github.rest.actions.downloadArtifact({
+               owner: context.repo.owner,
+               repo: context.repo.repo,
+               artifact_id: matchArtifact.id,
+               archive_format: 'zip',
+            });
+            let fs = require('fs');
+            fs.writeFileSync(`${process.env.GITHUB_WORKSPACE}/pr_number.zip`, Buffer.from(download.data));
+
+      - name: 'Unzip artifact'
+        run: unzip pr_number.zip
+
+      # Doesn't work across workflows
+      #- name: Get artifacts from flaw checker workflow
+      #  uses: actions/download-artifact@v3
+      #  with:
+      #    name: logs_and_errors
+      #    #path: ./logs
+
+      - name: Read errorsFilteredByPrPages.md file
+        id: read-errors-by-page
+        uses: juliangruber/read-file-action@v1
+        with:
+          path: ./errorsFilteredByPrPages.md
+
+      - name: Read PR number
+        id: read-error-pr-number
+        uses: juliangruber/read-file-action@v1
+        with:
+          path: ./pr_number
+
+      - name: File detail info
+        run: |
+          echo "${{ steps.read-errors-by-page.outputs.content }}"
+          echo "${{ steps.read-error-pr-number.outputs.content }}"
+
+      - name: Create or update comment
+        id: comment_to_pr
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          recreate: true
+          number: ${{ steps.read-error-pr-number.outputs.content }}
+          header: flaws
+          message: ${{ steps.read-errors-by-page.outputs.content || 'No flaws found' }}
+
+      #- name: Dump GitHub context
+      #  env:
+      #    GITHUB_CONTEXT: ${{ toJSON(github) }}
+      #  run: echo "$GITHUB_CONTEXT"
+
+      # Would like to do this, but it doesn't work (for me).
+      # Moving to time-based, or triggering on workflow
+      #- name: Wait for artifacts upload to succeed
+      #  uses: lewagon/wait-on-check-action@v1.3.1
+      #  with:
+      #    ref: ${{ github.ref }}
+      #    check-name: 'Archive production artifacts'
+      #    repo-token: ${{ secrets.GITHUB_TOKEN }}
+      #    wait-interval: 80
+
+      # Not needed for now - trying to trigger off the workflow
+      #- name: Sleep for 80 seconds
+      #  run: sleep 80s
+      #  shell: bash
+      #- name: Find Comment
+      #  uses: peter-evans/find-comment@v2
+      #  id: fc
+      #  with:
+      #    issue-number: ${{ steps.read-error-pr-number.outputs.content }}
+      #    comment-author: 'github-actions[bot]'
+      #    body-includes: Flaws (may be none)
+
+      #- name: Create or update comment
+      #  uses: peter-evans/create-or-update-comment@v3
+      #  with:
+      #    comment-id: ${{ steps.fc.outputs.comment-id }}
+      #    issue-number: ${{ steps.read-error-pr-number.outputs.content }}
+      #    body: |
+      #      Flaws (may be none)
+      #      ${{ steps.read-errors-by-page.outputs.content }}
+      #    edit-mode: replace

.github/workflows/python_checks.yml

@@ -4,9 +4,15 @@ on:
   push:
     branches:
     - 'main'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
   pull_request:
     branches:
     - '*'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
 
 jobs:
   build:

.github/workflows/ros_translation_node.yml

@@ -3,9 +3,15 @@ on:
   push:
     branches:
     - 'main'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
   pull_request:
     branches:
     - '*'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
 defaults:
   run:
     shell: bash

.github/workflows/sitl_tests.yml

@@ -9,9 +9,15 @@ on:
   push:
     branches:
     - 'main'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
   pull_request:
     branches:
     - '*'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/**'
 
 jobs:
   build:

docs/.gitignore

@@ -0,0 +1,21 @@
+# vitepress - user guide
+node_modules/
+.vitepress/cache/
+.vitepress/dist/
+.vitepress/.temp/
+
+# Book build output
+_book
+
+#log folder
+logs
+
+#backup files
+*.bak
+
+#Yarn log
+yarn-error.log
+
+
+# Generated alternative _summary.md
+# **/*/_summary.md

docs/.vitepress/config.mjs

@@ -0,0 +1,248 @@
+import { defineConfig } from "vitepress";
+const getSidebar = require("./get_sidebar.js");
+
+import openEditor from "open-editor"; // Open file locally via edit
+
+// Tabs: https://github.com/Red-Asuka/vitepress-plugin-tabs
+import tabsPlugin from "@red-asuka/vitepress-plugin-tabs";
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "PX4 Guide (main)",
+  description: "PX4 User and Developer Guide",
+  base: process.env.BRANCH_NAME
+    ? "/" + process.env.BRANCH_NAME + "/"
+    : "/px4_user_guide/",
+  srcExclude: [
+    "de/**/*.md",
+    "ja/**/*.md",
+    "ru/**/*.md",
+    "tr/**/*.md",
+    //"kr/**/*.md",
+    //"zh/**/*.md",
+    //"uk/**/*.md",
+    "**/_*.md", //Remove source docs that start with "_" (included/not rendered)
+  ],
+  ignoreDeadLinks: true,
+  markdown: {
+    math: true,
+    config: (md) => {
+      // use more markdown-it plugins!
+      tabsPlugin(md); //https://github.com/Red-Asuka/vitepress-plugin-tabs
+    },
+  },
+
+  vite: {
+    plugins: [
+      {
+        // Open file locally via edit
+        name: "open-in-editor",
+        configureServer(server) {
+          server.middlewares.use("/__open-in-editor", (req, res, next) => {
+            if (!req.url) return next();
+            const q = new URL(req.url, "http://a.com").searchParams;
+            const file = q.get("file");
+            if (!file) return next();
+            const line = Number.parseInt(q.get("line")) || 1;
+            const column = Number.parseInt(q.get("column")) || 1;
+            // Open editor if EDITOR environment variable is set
+            if (typeof process.env.EDITOR !== "undefined") {
+              openEditor([{ file, line, column }]);
+            } else {
+              console.warn(
+                "EDITOR environment variable is not set. Skipping opening file."
+              );
+            }
+            res.statusCode = 204;
+            res.end();
+          });
+        },
+      },
+    ],
+  },
+
+  locales: {
+    en: {
+      label: "English",
+      // other locale specific properties...
+      themeConfig: {
+        sidebar: getSidebar.sidebar("en"),
+        editLink: {
+          text:
+            /* We get a github link if CI env is defined,
+            or if it isn't defined and a local editor isn't defined) */
+            typeof process.env.CI !== "undefined" ||
+            typeof process.env.EDITOR === "undefined"
+              ? "Edit on GitHub"
+              : "Open in your editor",
+          pattern:
+            typeof process.env.CI !== "undefined" ||
+            typeof process.env.EDITOR === "undefined"
+              ? ({ filePath, frontmatter }) => {
+                  if (frontmatter.newEditLink) {
+                    //newEditLink defines a frontmatter key you can use to append a path to main
+                    return `https://github.com/PX4/PX4-Autopilot/edit/main/${frontmatter.newEditLink}`;
+                  } else {
+                    return `https://github.com/PX4/PX4-Autopilot/edit/main/${filePath}`;
+                  }
+                }
+              : (c) =>
+                  `${
+                    window.location.origin
+                  }/__open-in-editor?file=${encodeURIComponent(c.filePath)}`,
+        },
+      },
+    },
+
+    zh: {
+      label: "中文 (Chinese)",
+      lang: "zh-CN", // optional, will be added  as `lang` attribute on `html` tag
+      themeConfig: {
+        sidebar: getSidebar.sidebar("zh"),
+      },
+      // other locale specific properties...
+    },
+    ko: {
+      label: "한국어 (Korean)",
+      lang: "ko-KR", // optional, will be added  as `lang` attribute on `html` tag
+      themeConfig: {
+        sidebar: getSidebar.sidebar("ko"),
+      },
+
+      // other locale specific properties...
+    },
+
+    uk: {
+      label: "Мови (Ukrainian)",
+      lang: "uk-UA", // optional, will be added  as `lang` attribute on `html` tag
+      themeConfig: {
+        sidebar: getSidebar.sidebar("uk"),
+      },
+
+      // other locale specific properties...
+    },
+  },
+  //Logs every page loaded on build. Good way to catch errors not caught by other things.
+  async transformPageData(pageData, { siteConfig }) {
+    console.log(pageData.filePath);
+  },
+
+  //
+
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    logo: "/px4-logo.svg",
+    sidebar: getSidebar.sidebar("en"),
+
+    editLink: {
+      pattern: "https://crowdin.com/project/px4-user-guide",
+      text: "Edit translation on Crowdin",
+    },
+
+    search: {
+      provider: "local",
+      /*
+      provider: process.env.BRANCH_NAME ? "algolia" : "local",
+      options: {
+        appId: "HHWW7I44JO",
+        apiKey: "48919e1dffc6e0ce4c0d6331343d2c0e",
+        indexName: "px4",
+        searchParameters: {
+          facetFilters: [`version:${process.env.BRANCH_NAME}`],
+        },
+      },
+      */
+    },
+
+    nav: [
+      {
+        text: "PX4",
+        items: [
+          {
+            text: "Website",
+            link: "https://px4.io/",
+            ariaLabel: "PX4 website link",
+          },
+          {
+            text: "Autopilot Source Code",
+            link: "https://github.com/PX4/PX4-Autopilot",
+          },
+          {
+            text: "Docs Source Code",
+            link: "https://github.com/PX4/PX4-Autopilot/docs/",
+          },
+        ],
+      },
+      {
+        text: "Dronecode",
+        items: [
+          {
+            text: "QGroundControl",
+            link: "http://qgroundcontrol.com/",
+          },
+          {
+            text: "MAVSDK",
+            link: "https://mavsdk.mavlink.io/",
+          },
+          {
+            text: "MAVLINK",
+            link: "https://mavlink.io/en/",
+          },
+          {
+            text: "QGroundControl Guide",
+            link: "https://docs.qgroundcontrol.com/master/en/qgc-user-guide/",
+          },
+          {
+            text: "Dronecode Camera Manager",
+            link: "https://camera-manager.dronecode.org/en/",
+          },
+        ],
+      },
+      {
+        text: "Support",
+        link: "https://docs.px4.io/main/en/contribute/support.html",
+      },
+      {
+        text: "Version",
+        items: [
+          { text: "main", link: "https://docs.px4.io/main/en/" },
+          { text: "v1.15", link: "https://docs.px4.io/v1.15/en/" },
+          { text: "v1.14", link: "https://docs.px4.io/v1.14/en/" },
+          { text: "v1.13", link: "https://docs.px4.io/v1.13/en/" },
+          { text: "v1.12", link: "https://docs.px4.io/v1.12/en/" },
+          { text: "v1.11", link: "https://docs.px4.io/v1.11/en/" },
+        ],
+      },
+    ],
+
+    socialLinks: [
+      { icon: "github", link: "https://github.com/PX4/PX4-Autopilot" },
+    ],
+  },
+
+  head: [
+    [
+      "script",
+      {
+        async: "",
+        src: "https://www.googletagmanager.com/gtag/js?id=G-91EWVWRQ93",
+      },
+    ],
+    [
+      "script",
+      {},
+      `window.dataLayer = window.dataLayer || [];
+      function gtag(){dataLayer.push(arguments);}
+      gtag('js', new Date());
+      gtag('config', 'G-91EWVWRQ93');`,
+    ],
+  ],
+
+  vue: {
+    template: {
+      compilerOptions: {
+        isCustomElement: (tag) => tag === "lite-youtube",
+      },
+    },
+  },
+});

docs/.vitepress/get_sidebar.js

@@ -0,0 +1,267 @@
+// .vuepress/get_sidebar.js
+
+import path from "path";
+import fs from "fs";
+import readline from "readline";
+
+function getEntryArray(parent) {
+  let returnEntryArray = null;
+  //console.log("getEntryArray(): parent");
+  //console.log(parent);
+  //Gets returns the child array
+  //if (parent === "undefined") {
+  //  return [];
+  //}
+
+  if (Array.isArray(parent)) {
+    //This parent is an array, so return it (it is the sidebar top level)
+    returnEntryArray = parent;
+    //console.log("isArray");
+  }
+  parent.items = parent?.items ? parent.items : [];
+  //console.log("isNotArray");
+  //console.log("returnEntryArray:");
+  returnEntryArray = parent.items;
+  //console.log(returnEntryArray);
+  return returnEntryArray;
+}
+
+function parseGitbookSidebarToVuepress(sidebarContent, lang) {
+  const lines = sidebarContent.split("\n");
+
+  const newSidebar = [];
+
+  let first_iteration = true;
+  let indent_divider = 0;
+
+  const parents = [];
+  //console.log("parents - empty after creaton");
+  //console.log(parents);
+
+  const topLevelParent = {
+    title: "DUMMY",
+    path: "DUMMY",
+    //level: "0",
+    //items: [],
+  };
+  topLevelParent.items = [];
+  //console.log("topLevelParent - empty after creaton");
+  //console.log(topLevelParent);
+
+  parents.push(topLevelParent); // So last item is always the sidebar
+  //console.log("parents after pushing topLevelParent:");
+  //console.log(parents);
+
+  let current_parent;
+
+  let lastlevel = 0;
+  let last_item;
+
+  //let currentSection;
+  //let currentLevel = 0;
+
+  lines.forEach((line) => {
+    if (line.startsWith("#") || line.trim() === "") {
+      // Ignore lines that start with "#" or are empty
+      // Note, we should perhaps create sections for these. TBD.
+      return;
+    }
+
+    //console.log("DEBUG: Line: " + line);
+
+    let regex = /(\s*?)[\*-]\s\[(.*?)\]\((.*?)\)/g;
+
+    let indent_level = "";
+    let link_title = "";
+    let link_url = "";
+    let link_path = "";
+
+    try {
+      //console.log(`DEBUG: Lastitem at start:  ${JSON.stringify(last_item)}`);
+      let match = regex.exec(line);
+      //console.log('0: '+ match[0])
+      indent_level = match[1].length;
+      link_title = match[2];
+      link_url = match[3].trim();
+      link_path = link_url;
+    } catch (err) {
+      //Just skip empty lines that don't match
+      console.log(err);
+      console.log("DEBUG: Couldn't match line, skip line using return");
+      return;
+    }
+
+    try {
+      /*
+      if (link_url.endsWith("README.md")) {
+        link_url = link_url.replace("README.md", "");
+      }
+      */
+      if (link_url.endsWith(".md")) {
+        link_url = link_url.replace(".md", ".html");
+        //link_path = link_path.replace(".md", ".html");
+      }
+
+      if (!link_url.startsWith("http")) {
+        if (lang) {
+          link_url = `/${lang}/${link_url}`;
+        } else {
+          link_url = `/${link_url}`;
+        }
+      }
+
+      //Tidy up some of the title escaping that isn't used by VuePress
+      link_title = link_title.replace("\\(", "(");
+      link_title = link_title.replace("\\)", ")");
+      link_title = link_title.replace("\\_", "_");
+
+      //set indent_divider level (easier to think in levels, numbers of zero prefixes)
+      if ((indent_divider == 0) & (indent_level > 0.0)) {
+        indent_divider = indent_level;
+      }
+      if (indent_divider > 0) {
+        indent_level = indent_level / indent_divider;
+      }
+
+      let entry = {
+        text: link_title,
+        link: link_url,
+        //collapsed: true,
+        //link_path,
+        //level: indent_level,
+        //collapsible: true,
+      };
+      //console.log("entry:");
+      //console.log(entry);
+
+      //console.log("parents:");
+      //console.log(parents);
+      //console.log("current_parent - before pop");
+      //console.log(current_parent);
+      current_parent = parents.pop();
+      //console.log("current_parent - after pop");
+      //console.log(current_parent);
+
+      //console.log(`XX ST: indent: ${indent_level} lastlevel: ${lastlevel}`);
+      if (indent_level == lastlevel) {
+        //console.log(`XX EQ:`);
+        //console.log(current_parent);
+        const parentArray = getEntryArray(current_parent);
+        parentArray.push(entry);
+        //console.log("current_parent after pushing last entry");
+        //console.log(current_parent);
+
+        //console.log("eq parents before pushing back current parent");
+        //console.log(parents);
+        parents.push(current_parent);
+        //console.log("EQ parents after pushing current parent");
+        //console.log(parents);
+
+        //console.log("XX EQ3");
+      } else if (indent_level > lastlevel) {
+        //console.log("XX NEST");
+        //console.log(
+        //  `  DEBUG:NEST: lastlev: ${lastlevel}/indent lev: ${indent_level}`
+        // );
+        // This is a child of the last element added to current parent
+
+        //console.log(current_parent);
+        //console.log("NEST: current_parent - after pop");
+        //console.log("NEST: parents before");
+        //console.log(parents);
+
+        const parentArray = getEntryArray(current_parent);
+
+        //console.log(
+        //  "parentArray - we want to add entry to last entry in this array."
+        //);
+        //console.log(parentArray);
+
+        //Get the last element
+        //console.log(`how many elements in array ${parentArray.length}`);
+        //
+        const lastElement = parentArray.pop();
+        lastElement.collapsed = true;
+        //console.log(`NEST: last element in array:`);
+        //console.log(lastElement);
+        const lastElementArray = getEntryArray(lastElement);
+        //console.log(`NEST: last element array:`);
+        lastElementArray.push(entry);
+        //console.log(`NEST: last element after pushing event:`);
+        //console.log(lastElement);
+        // Push the last element back on to the parentArray
+        parentArray.push(lastElement);
+        //push current parent onto the parents array
+        parents.push(current_parent);
+        // push the element we just edited back onto the array so it can be current parent.
+        parents.push(lastElement);
+        //console.log("NEST: parents after");
+        //console.log(parents);
+      } else if (indent_level < lastlevel) {
+        // gone up a level
+        //console.log(`XX UP`);
+        while (indent_level < lastlevel--) {
+          //console.log(`pop ${lastlevel}`);
+          //Here we have no item. Group has finished (with a group)
+          //So add the current parent (finished) to its parent.
+          //console.log('DEBUG: Gone UP from level: '+ indent_level + ' TO: ' + lastlevel)
+
+          current_parent = parents.pop();
+        }
+        const parentArray = getEntryArray(current_parent);
+        parentArray.push(entry);
+        //console.log("current_parent after pushing last entry");
+        //console.log(current_parent);
+
+        //console.log("eq parents before pushing back current parent");
+        //console.log(parents);
+        parents.push(current_parent);
+      }
+
+      //console.log("AFTER ADDING Entry:");
+      //console.log("entry:");
+      //console.log(entry);
+      //console.log("parents:");
+      //console.log(parents);
+    } catch (err) {
+      console.log(err);
+      console.log(` DEBUG SOME ACTUAL PROBLEMXX2: ${err}`);
+    }
+
+    //last_item = entry;
+
+    lastlevel = indent_level; //reset
+    //console.log(`END OF ONE LINE:${indent_level} lastlevel: ${lastlevel}`);
+    //console.log("PARENTS");
+    //console.log(JSON.stringify(parents));
+  });
+
+  //all lines done
+  //console.log("All lines done parents:");
+  //console.log(JSON.stringify(parents));
+
+  //console.log("topLevelParent");
+  //console.log(topLevelParent);
+  return topLevelParent.items;
+}
+
+module.exports = {
+  sidebar: function (lang) {
+    const summaryfile_path = path.resolve(__dirname, "..", lang, "SUMMARY.md");
+    //console.log("DEBUG: summaryfile_path: " + summaryfile_path);
+    let data = "";
+
+    try {
+      // read contents of the file
+      data = fs.readFileSync(summaryfile_path, "UTF-8");
+    } catch (err) {
+      console.log(`DEBUG: ${lang} - SIDEBAR  DEFINITION NOT FOUND`);
+    }
+
+    const module_sidebar = parseGitbookSidebarToVuepress(data, lang);
+    //console.log(`DEBUG: Before`);
+    //console.log(`DEBUG: ${JSON.stringify(module_sidebar)}`);
+    //console.log(`DEBUG: After`);
+    return module_sidebar;
+  },
+};

docs/.vitepress/theme/components/Redirect.vue

@@ -0,0 +1,19 @@
+<template>
+</template>
+
+
+<script>
+    /** Redirects to the given 'to' url, which is relative to the current location. Originates from https://github.com/vuejs/vuepress/issues/239#issuecomment-632567115 */
+    export default {
+        name: 'Redirect',
+        props: {
+            to: {
+                type: String,
+                required: true
+            }
+        },
+        beforeMount() {
+            document.location.replace(this.to);
+        }
+    }
+</script>

docs/.vitepress/theme/index.js

@@ -0,0 +1,58 @@
+// https://vitepress.dev/guide/custom-theme
+import { h } from "vue";
+
+import DefaultTheme from "vitepress/theme";
+import "./style.css";
+
+// To support medium-zoom - like setup()
+import { onMounted, watch, nextTick } from "vue";
+import { useRoute } from "vitepress";
+import mediumZoom from "medium-zoom";
+
+// For https://www.npmjs.com/package/lite-youtube-embed
+import { inBrowser } from "vitepress";
+import "lite-youtube-embed/src/lite-yt-embed.css";
+if (inBrowser) {
+  // @ts-ignore
+  import("lite-youtube-embed");
+}
+
+// Support redirect plugin
+import Redirect from "./components/Redirect.vue";
+
+// Tabs: https://github.com/Red-Asuka/vitepress-plugin-tabs
+import { Tab, Tabs } from "vue3-tabs-component";
+import "@red-asuka/vitepress-plugin-tabs/dist/style.css";
+
+/** @type {import('vitepress').Theme} */
+export default {
+  extends: DefaultTheme,
+  Layout: () => {
+    return h(DefaultTheme.Layout, null, {
+      // https://vitepress.dev/guide/extending-default-theme#layout-slots
+    });
+  },
+  enhanceApp({ app, router, siteData }) {
+    app.component("Redirect", Redirect); //Redirect plugin
+    //Tabs: https://github.com/Red-Asuka/vitepress-plugin-tabs
+    app.component("Tab", Tab);
+    app.component("Tabs", Tabs);
+  },
+
+  // to support medium zoom: https://github.com/vuejs/vitepress/issues/854
+  setup() {
+    const route = useRoute();
+    const initZoom = () => {
+      //mediumZoom("[data-zoomable]", { background: "var(--vp-c-bg)" });
+      mediumZoom(".main img", { background: "var(--vp-c-bg)" });
+    };
+    onMounted(() => {
+      initZoom();
+    });
+    watch(
+      () => route.path,
+      () => nextTick(() => initZoom())
+    );
+  },
+  //end to support medium zoom
+};

docs/.vitepress/theme/style.css

@@ -0,0 +1,162 @@
+/**
+ * Customize default theme styling by overriding CSS variables:
+ * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
+ */
+
+/**
+ * Colors
+ *
+ * Each colors have exact same color scale system with 3 levels of solid
+ * colors with different brightness, and 1 soft color.
+ *
+ * - `XXX-1`: The most solid color used mainly for colored text. It must
+ *   satisfy the contrast ratio against when used on top of `XXX-soft`.
+ *
+ * - `XXX-2`: The color used mainly for hover state of the button.
+ *
+ * - `XXX-3`: The color for solid background, such as bg color of the button.
+ *   It must satisfy the contrast ratio with pure white (#ffffff) text on
+ *   top of it.
+ *
+ * - `XXX-soft`: The color used for subtle background such as custom container
+ *   or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
+ *   on top of it.
+ *
+ *   The soft color must be semi transparent alpha channel. This is crucial
+ *   because it allows adding multiple "soft" colors on top of each other
+ *   to create a accent, such as when having inline code block inside
+ *   custom containers.
+ *
+ * - `default`: The color used purely for subtle indication without any
+ *   special meanings attched to it such as bg color for menu hover state.
+ *
+ * - `brand`: Used for primary brand colors, such as link text, button with
+ *   brand theme, etc.
+ *
+ * - `tip`: Used to indicate useful information. The default theme uses the
+ *   brand color for this by default.
+ *
+ * - `warning`: Used to indicate warning to the users. Used in custom
+ *   container, badges, etc.
+ *
+ * - `danger`: Used to show error, or dangerous message to the users. Used
+ *   in custom container, badges, etc.
+ * -------------------------------------------------------------------------- */
+
+ :root {
+  --vp-c-default-1: var(--vp-c-gray-1);
+  --vp-c-default-2: var(--vp-c-gray-2);
+  --vp-c-default-3: var(--vp-c-gray-3);
+  --vp-c-default-soft: var(--vp-c-gray-soft);
+
+  --vp-c-brand-1: var(--vp-c-indigo-1);
+  --vp-c-brand-2: var(--vp-c-indigo-2);
+  --vp-c-brand-3: var(--vp-c-indigo-3);
+  --vp-c-brand-soft: var(--vp-c-indigo-soft);
+
+  --vp-c-tip-1: var(--vp-c-brand-1);
+  --vp-c-tip-2: var(--vp-c-brand-2);
+  --vp-c-tip-3: var(--vp-c-brand-3);
+  --vp-c-tip-soft: var(--vp-c-brand-soft);
+
+  --vp-c-warning-1: var(--vp-c-yellow-1);
+  --vp-c-warning-2: var(--vp-c-yellow-2);
+  --vp-c-warning-3: var(--vp-c-yellow-3);
+  --vp-c-warning-soft: var(--vp-c-yellow-soft);
+
+  --vp-c-danger-1: var(--vp-c-red-1);
+  --vp-c-danger-2: var(--vp-c-red-2);
+  --vp-c-danger-3: var(--vp-c-red-3);
+  --vp-c-danger-soft: var(--vp-c-red-soft);
+}
+
+/**
+ * Component: Button
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-button-brand-border: transparent;
+  --vp-button-brand-text: var(--vp-c-white);
+  --vp-button-brand-bg: var(--vp-c-brand-3);
+  --vp-button-brand-hover-border: transparent;
+  --vp-button-brand-hover-text: var(--vp-c-white);
+  --vp-button-brand-hover-bg: var(--vp-c-brand-2);
+  --vp-button-brand-active-border: transparent;
+  --vp-button-brand-active-text: var(--vp-c-white);
+  --vp-button-brand-active-bg: var(--vp-c-brand-1);
+}
+
+/**
+ * Component: Home
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: -webkit-linear-gradient(
+    120deg,
+    #bd34fe 30%,
+    #41d1ff
+  );
+
+  --vp-home-hero-image-background-image: linear-gradient(
+    -45deg,
+    #bd34fe 50%,
+    #47caff 50%
+  );
+  --vp-home-hero-image-filter: blur(44px);
+}
+
+@media (min-width: 640px) {
+  :root {
+    --vp-home-hero-image-filter: blur(56px);
+  }
+}
+
+@media (min-width: 960px) {
+  :root {
+    --vp-home-hero-image-filter: blur(68px);
+  }
+}
+
+/**
+ * Component: Custom Block
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-custom-block-tip-border: transparent;
+  --vp-custom-block-tip-text: var(--vp-c-text-1);
+  --vp-custom-block-tip-bg: var(--vp-c-brand-soft);
+  --vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
+}
+
+/**
+ * Component: Algolia
+ * -------------------------------------------------------------------------- */
+
+.DocSearch {
+  --docsearch-primary-color: var(--vp-c-brand-1) !important;
+}
+
+
+
+
+/**
+ * Component: Medium Zoom: https://github.com/vuejs/vitepress/issues/854
+ * -------------------------------------------------------------------------- */
+
+.medium-zoom-overlay {
+  z-index: 20;
+}
+
+.medium-zoom-image {
+  z-index: 21;
+}
+
+
+/**
+ * Override styles as needed
+ * -------------------------------------------------------------------------- */
+
+ .vp-doc img {
+  display: inline; /* block by default set by vitepress */
+}

docs/CNAME

@@ -0,0 +1 @@
+docs.px4.io

docs/LICENSE

@@ -0,0 +1,101 @@
+CC BY 4.0
+
+Licence: https://creativecommons.org/licenses/by/4.0/legalcode
+Human-readable format: https://creativecommons.org/licenses/by/4.0/
+
+Creative Commons Attribution 4.0 International Public License
+==============================================================
+
+Creative Commons Attribution 4.0 International Public License
+By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
+
+Section 1 – Definitions.
+
+a.	Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
+b.	Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
+c.	Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
+d.	Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
+e.	Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
+f.	Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
+g.	Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
+h.	Licensor means the individual(s) or entity(ies) granting rights under this Public License.
+i.	Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
+j.	Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
+k.	You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
+
+Section 2 – Scope.
+
+a.	License grant.
+  1.	Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
+    A.	reproduce and Share the Licensed Material, in whole or in part; and
+    B.	produce, reproduce, and Share Adapted Material.
+  2.	Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
+  3.	Term. The term of this Public License is specified in Section 6(a).
+  4.	Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
+  5.	Downstream recipients.
+    A.	Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
+    B.	No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
+  6.	No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
+b.	Other rights.
+  1.	Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
+  2.	Patent and trademark rights are not licensed under this Public License.
+  3.	To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.
+
+
+Section 3 – License Conditions.
+
+Your exercise of the Licensed Rights is expressly made subject to the following conditions.
+a.	Attribution.
+  1.	If You Share the Licensed Material (including in modified form), You must:
+    A.	retain the following if it is supplied by the Licensor with the Licensed Material:
+      i.	identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
+      ii.	a copyright notice;
+      iii.	a notice that refers to this Public License;
+      iv.	a notice that refers to the disclaimer of warranties;
+      v.	a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
+    B.	indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
+    C.	indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
+      2.	You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
+      3.	If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
+      4.	If You Share Adapted Material You produce, the Adapter's License You apply must not prevent recipients of the Adapted Material from complying with this Public License.
+
+
+Section 4 – Sui Generis Database Rights.
+
+Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
+a.	for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database;
+b.	if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material; and
+c.	You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
+For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
+
+
+Section 5 – Disclaimer of Warranties and Limitation of Liability.
+
+a.	Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.
+b.	To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.
+c.	The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
+
+
+Section 6 – Term and Termination.
+
+a.	This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
+b.	Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
+  1.	automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
+  2.	upon express reinstatement by the Licensor.
+For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
+c.	For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
+d.	Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
+
+
+Section 7 – Other Terms and Conditions.
+
+a.	The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
+b.	Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
+
+
+Section 8 – Interpretation.
+
+a.	For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
+b.	To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
+c.	No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
+d.	Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.

docs/README.md

@@ -0,0 +1,6 @@
+# PX4 User Guide
+
+This repo contains the source code for the [PX4 User Guide](https://docs.px4.io/main/en/).
+
+> [!NOTE]
+> [Contributions](https://docs.px4.io/main/en/contribute/docs.html) and [Translations](https://docs.px4.io/main/en/contribute/translation.html) to this guide are very welcome!

docs/_link_checker_sc/ignorefile.json

@@ -0,0 +1 @@
+["en/_sidebar.md"]