This repository contains the technical and architecture documents for AppStudio. User documentation is out of scope.
/book folder hosts the technical overview document. This document represents the latest state of agreed technical and architectural decisions. See contributing on how to propose changes.
/ref folder hosts the API references for all the related services. These API references are generated during publish flow.
architecture-overview-slides.md is the source for the slides. The slides are done on .md and can be rendered using reveal.js
/diagrams folder stores the diagrams used on the overview document and slides. These diagrams are done using draw.io and stored in .svg format.
/ADR folder contains the ADRs that are executed as part of the process to update these documents as explained in contributing section.
All changes to the documents and diagrams require a peer-reviewed pull request.
For significant changes that include changes to technical details or architecture the pull request should have
- Changes to the overview document, slides and diagrams where applicable.
- An ADR record is added to the
/ADRfolder. - At least 2 approvals to be merged
The changes that are corrections and clarifications and that do not reflect a significant change pull request should have
- Changes to the overview document, slides and diagrams where applicable.
- Should have a
skip-adr-checklabel - At least 1 approval