Skip to content

Bugfix README.md #534

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.

Sign up for GitHub

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

Closed
drtrigon wants to merge 4 commits into from
Closed

Bugfix README.md #534

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7b499f9
bugfix; ArduPilot `SRx_` parameters note
drtrigon Apr 12, 2026
4ebeeaa
follow-up; move note from general section to ArduPilot
drtrigon Apr 13, 2026
307c27b
update; docker-compose is now external and deps needed
drtrigon Apr 13, 2026
c8718b3
undo
drtrigon Apr 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,18 +29,20 @@ If you don't have time to lend a hand in that way but still want to have an impa
You need to have [docker](https://docs.docker.com/engine/install/)
and [docker-compose](https://docs.docker.com/compose/install/) installed in your environment.

If you edit the docs in vscode when you open the top level directory it will ask if you wish to `Reopen in Container` click that button and vscode will automatically run `docker compose up` which will then start serving the documentation as below, otherwise you can do it manually as below.
If you edit the docs in vscode when you open the top level directory it will ask if you wish to `Reopen in Container` click that button and vscode will automatically run `docker-compose up` which will then start serving the documentation as below, otherwise you can do it manually as below.

If you run the container on debian, please install `docker.io`, `docker-compose` and `apparmor` as dependencies from system repos.

Then you need to build your container:

```
docker compose build
docker-compose build
```

and start mkdocs server:

```
docker compose up
docker-compose up
```

After server is running visit [http://localhost:8000/](http://localhost:8000/).
Expand Down
Loading