This repository contains the technical and architecture documents for Konflux. User documentation is out of scope.
/architecture folder hosts the 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.
/diagrams folder stores the diagrams used on the overview document. 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 peer-reviewed pull requests. See CONTRIBUTING.md for detailed guidelines on:
- Pull request requirements
- Adding new services
- Adding new ADRs
- Maintaining documentation structure