Documentation¶
This documentation is built using Zensical, a static site generator for documentation. It uses Markdown files to generate a static website with a clean and modern design.
For full documentation visit zensical.org.
The content in this site is split into project guidance and service reference pages. Service pages describe both the exercise contract and the implementation status visible in this repository; they do not imply that an absent submodule has already been implemented.
Documentation structure¶
| Directory | Contents |
|---|---|
project/ |
Scope, organization, rules and delivery |
development/ |
Setup, development, testing and CI/CD |
infrastructure/ |
AWS, EKS, deployment and costs |
operations/ |
Observability, performance and load testing |
services/ |
API contracts and service reference |
frontend/ |
Landing/store/admin content, architecture, packages, PWA, telemetry, local testing and verification |
Commands¶
zensical new- Create a new projectzensical serve- Start local web serverzensical build- Build your site
Website¶
It is also possible to view the documentation online at the deployed github page: https://microsserv52.github.io/platform/.
Writing rules¶
- Keep endpoint examples valid JSON.
- Document authentication and all relevant success and error status codes.
- Link to the owning service and to related cross-service contracts.
- Mark planned behavior explicitly instead of presenting it as implemented.