README update with maintenance instructions
Tasks
-
Add into the README: -
Onion Services doc conventions, including: - Use the navigation format from the mkdocs-awesome-pages-plugin.
- Have
README.md
orindex.md
listed as the "Intro" page. - Have a link to the repository in the README/index page.
-
How to contribute with new docs: - Open an issue request or pull request for an evaluation/integration.
-
How to integrate your existing docs: - Need to be Onion Service related.
- Setup Onion MkDocs.
- Adopt the Onion Services doc conventions.
- Adhere to the Community Team docs guidelines.
- Open an issue request or pull request for an evaluation/integration.
-
Time estimation
- Complexity: very small (0.5 day)
- Uncertainty: low (x1.1)
- Reference (adapted)
Edited by Silvio Rhatto