pmaports/docs
Pablo Correa Gómez 6adc515825
docs/device-categorization: remove subjective image-building requirement
This is not something we can measure or reason about, since "obscure"
is very subjective. An alternative of using "multiple users" has also
been discarded, since we don't have a way to measure that either for
now.

Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7077>
2025-09-25 19:55:23 +00:00
..
modules/ROOT docs/device-categorization: remove subjective image-building requirement 2025-09-25 19:55:23 +00:00
antora.yml docs: initial documentation for pmaports 2025-09-24 12:37:31 +02:00
README.md docs: initial documentation for pmaports 2025-09-24 12:37:31 +02:00

pmaports docs

This is part of the postmarketOS handbook. The documentation is built using Antora since it allows pulling information from different repositories, which is a great benefit on a distributed project like ours. To build the documentation locally install nodejs and npm from your favorite package manager, and from the top folder of the repository run:

npm install antora
npx antora --clean antora-test.yml

After running the commands Antora should print the location of the generated documentation.

Alternatively, you can use pmbootstrap ci build-docs.