04-Docs
PVARKI-Docs is a Docusaurus-build simple static page website that lets users to access illustrated User Guides they need, and developers to access specs & docs & howto of the PVARKI Stack
Natural Language
- Docusaurus-built webapp
- Is accessible as a website
- Gives you all information you need in a polished package, whether you were an user or developer
—————————
Purpose
The purpose of Docs is to
- Let users easily access illustrated guides on how to use the Stack,
- Let developers easily access comprehensive docs on how to and where to develop the stack,
- Be capable of being served as a static page, and exportable eg. inside a deployment
- Be easily editable so that especially guides are quick to create
Users
Stack users - from fighter to leader.
Developers - from familiars to outside organizations.
Technical Requirements
R1. Release a docker image that can be mounted in eg. compose or K8s to be shown inside a deployment.
R2. Safely handle semi/automatic input of docs from fast-track editors such as Outline.
R3. Handle input of readmes and apidocs from the relevant repositories.