Link fixes galore (#25151)

This commit is contained in:
Hamish Willee
2025-07-03 14:53:12 +10:00
committed by GitHub
parent dd0d00aedc
commit 375f421c61
107 changed files with 836 additions and 972 deletions
+1 -2
View File
@@ -14,7 +14,7 @@ However, due to the global team and fast moving development we might resort to m
To contribute new functionality, [sign up for Github](https://docs.github.com/en/get-started/signing-up-for-github/signing-up-for-a-new-github-account), then [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository, [create a new branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository), add your [changes as commits](#commits-and-commit-messages), and finally [send a pull request](#pull-requests).
Changes will be merged when they pass our [continuous integration](https://en.wikipedia.org/wiki/Continuous_integration) tests.
All code contributions have to be under the permissive [BSD 3-clause license](https://opensource.org/licenses/BSD-3-Clause) and all code must not impose any further constraints on the use.
All code contributions have to be under the permissive [BSD 3-clause license](https://opensource.org/license/BSD-3-Clause) and all code must not impose any further constraints on the use.
## Code Style
@@ -109,7 +109,6 @@ Currently we have two types of source-based documentation:
Developers should name C++ entities (classes, functions, variables etc.) such that their purpose can be inferred - reducing the need for explicit documentation.
:::
- Do not add documentation that can trivially be inferred from C++ entity names.
- ALWAYS specify units of variables, constants, and input/return parameters where they are defined.
- Commonly you may want to add information about corner cases and error handling.
+2 -2
View File
@@ -29,11 +29,11 @@ This is a great opportunity to meet the team and contribute to the ongoing devel
## What gets discussed?
We publish a forum post per meeting a week before the call on [PX4 Discuss - weekly-dev-call](https://discuss.px4.io/c/weekly-dev-call) and track the agenda write down the discussion for the day. We welcome any topics that you, as a community member may have questions about / want to discuss!
We publish a forum post per meeting a week before the call on [PX4 Discuss - weekly-dev-call](https://discuss.px4.io/c/weekly-dev-call/14) and track the agenda write down the discussion for the day. We welcome any topics that you, as a community member may have questions about / want to discuss!
Please add your topics for discussion to the agenda before the meeting begins, by replying to the meeting note. This will help you formulate your questions more clearly, and allow us to think about them in advance.
## Schedule
- TIME: Wednesday 17h00 CET ([subscribe to calendar](https://www.dronecode.org/calendar/))
- TIME: Wednesday 17h00 CET ([subscribe to calendar](https://dronecode.org/calendar/))
- **Join the call**: [https://discord.gg/BDYmr6FA6Q](https://discord.gg/BDYmr6FA6Q)
+2 -10
View File
@@ -36,7 +36,7 @@ For these kinds of changes we suggest using the same approach as for _code_:
1. Use the _git_ toolchain to get the PX4 source code onto your local computer.
1. Modify the documentation as needed (add, change, delete).
1. _Test_ that it builds properly using Vitepress.
1. Create a branch for your changes and create a pull request (PR) to pull it back into the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot.git) repo.
1. Create a branch for your changes and create a pull request (PR) to pull it back into the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) repo.
The following explain how to get the source code, build locally (to test), and modify the code.
@@ -55,7 +55,7 @@ To get the library(s) sources onto your local computer you will need to use the
The instructions below explain how to get git and use it on your local computer.
1. Download git for your computer from [https://git-scm.com/downloads](https://git-scm.com/downloads)
1. [Sign up](https://github.com/join) for Github if you haven't already
1. [Sign up](https://github.com/signup) for Github if you haven't already
1. Create a copy (Fork) of the [PX4-Autopilot repo](https://github.com/PX4/PX4-Autopilot) on Github ([instructions here](https://docs.github.com/en/get-started/quickstart/fork-a-repo)).
1. Clone (copy) your forked repository to your local computer:
@@ -127,7 +127,6 @@ Within the repository you created above:
6. Go to your forked repository on Github in a web browser, e.g.: `https://github.com/<your git name>/PX4-Autopilot.git`.
There you should see the message that a new branch has been pushed to your forked repository.
7. Create a pull request (PR):
- On the right hand side of the "new branch message" (see one step before), you should see a green button saying "Compare & Create Pull Request".
Press it.
- A pull request template will be created.
@@ -145,7 +144,6 @@ Within the repository you created above:
Build the library locally to test that any changes you have made have rendered properly:
1. Install the [Vitepress prerequisites](https://vitepress.dev/guide/getting-started#prerequisites):
- [Nodejs 18+](https://nodejs.org/en)
- [Yarn classic](https://classic.yarnpkg.com/en/docs/install)
@@ -175,7 +173,6 @@ Build the library locally to test that any changes you have made have rendered p
First specify a local text editor file using the `EDITOR` environment variable, before calling `yarn start` to preview the library.
For example, you can enable VSCode as your default editor by entering:
- Windows:
```sh
@@ -223,7 +220,6 @@ In overview:
- All pages must be in an appropriately named sub-folder of `/en` (e.g. this page is in folder `en/contribute/`).
- This makes linking easier because other pages and images are always as the same relative levels
- The _structure_ of the book is defined in `SUMMARY.md`.
- If you add a new page to the guide you must also add an entry to this file!
:::tip
@@ -247,7 +243,6 @@ When you add a new page you must also add it to `en/SUMMARY.md`!
## Style Guide
1. Files/file names
- Put new markdown files in an appropriate sub-folder of `/en/`, such as `/en/contribute/`.
Do not further nest folders.
- Put new image files in an appropriate nested sub-folder of `/assets/`.
@@ -257,14 +252,12 @@ When you add a new page you must also add it to `en/SUMMARY.md`!
- Use lower case filenames and separate words using underscores (`_`).
2. Images
- Use the smallest size and lowest resolution that makes the image still useful (this reduces download cost for users with poor bandwidth).
- New images should be created in a sub-folder of `/assets/` (so they can be shared between translations).
- SVG files are preferred for diagrams.
PNG files are preferred over JPG for screenshots.
3. Content:
- Use "style" (**bold**, _emphasis_, etc.) consistently and sparingly (as little as possible).
- **Bold** for button presses and menu definitions.
- _Emphasis_ for tool names such as _QGroundControl_ or _prettier_.
@@ -279,7 +272,6 @@ When you add a new page you must also add it to `en/SUMMARY.md`!
- Format using _prettier_ (_VSCode_ is a has extensions can be used for this).
4. Videos:
- Youtube videos can be added using the format `<lite-youtube videoid="<youtube-video-id>" title="your title"/>` (supported via the [https://www.npmjs.com/package/lite-youtube-embed](https://www.npmjs.com/package/lite-youtube-embed) custom element, which has other parameters you can pass).
- Use instructional videos sparingly as they date badly, and are hard to maintain.
- Cool videos of airframes in flight are always welcome.
+3 -3
View File
@@ -6,7 +6,7 @@
Adding a feature to PX4 follows a defined workflow. In order to share your contributions on PX4, you can follow this example.
- [Sign up](https://github.com/join) for github if you haven't already
- [Sign up](https://github.com/signup) for github if you haven't already
- Fork the PX4-Autopilot repo (see [here](https://docs.github.com/en/get-started/quickstart/fork-a-repo))
- Clone your forked repository to your local computer
@@ -45,7 +45,7 @@ Adding a feature to PX4 follows a defined workflow. In order to share your contr
git add <file name>
```
If you prefer having a GUI to add your files see [Gitk](https://git-scm.com/book/en/v2/Git-in-Other-Environments-Graphical-Interfaces) or [`git add -p`](http://nuclearsquid.com/writings/git-add/).
If you prefer having a GUI to add your files see [Gitk](https://git-scm.com/book/en/v2/Git-in-Other-Environments-Graphical-Interfaces) or [`git add -p`](https://nuclearsquid.com/writings/git-add/).
- Commit the added files with a meaningful message explaining your changes
@@ -285,7 +285,7 @@ If a conflict occurs during a `git rebase`, please refer to [this guide](https:/
### Pull merge conflicts
If a conflict occurs during a `git pull`, please refer to [this guide](https://help.github.com/articles/resolving-a-merge-conflict-using-the-command-line/#competing-line-change-merge-conflicts).
If a conflict occurs during a `git pull`, please refer to [this guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line#competing-line-change-merge-conflicts).
### Build error due to git tags out of date
+2 -2
View File
@@ -1,12 +1,12 @@
# Licenses
::: info
All code contributions must be made under the permissive [BSD 3-clause license](https://opensource.org/licenses/BSD-3-Clause) and must not impose any further constraints on its use.
All code contributions must be made under the permissive [BSD 3-clause license](https://opensource.org/license/BSD-3-Clause) and must not impose any further constraints on its use.
:::
This page documents the licenses of various components in the system.
- [PX4 Flight Stack](https://github.com/PX4/PX4-Autopilot) &mdash; BSD
- [PX4 Middleware](https://github.com/PX4/PX4-Autopilot) &mdash; BSD
- [Pixhawk Hardware](https://github.com/PX4/Hardware) &mdash; CC-BY-SA 3.0
- [Pixhawk Hardware](https://github.com/pixhawk/Hardware) &mdash; CC-BY-SA 3.0
- [PX4 User Guide](https://github.com/PX4/PX4-user_guide) (Documentation) &mdash; [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).