Contributing to Platform Core¶
Setup¶
See setup instructions in the repo README.
Doc Contribution¶
- Docs live in
docs/ - MkDocs Material is used to build them
- All doc changes go through MR — reviewed by
@platform-architect - To preview locally:
docker run --rm -p 8000:8000 -v $(pwd):/docs squidfunk/mkdocs-material
ADRs¶
For any significant architectural decision, create an ADR:
1. Copy the MADR template
2. Name it docs/adr/ADR-NNNN-short-title.md
3. Add it to docs/adr/index.md
4. Open an MR — ADRs require architect review