This repository contains the architectural documentation for the Platform Mesh.
Architecture decisions and design proposals are documented through two complementary formats:
- Architecture Decision Records (ADRs) — capture significant technical decisions along with their context and consequences. ADRs follow the MADR template.
- Requests for Comments (RFCs) — propose and discuss larger features or cross-cutting changes before implementation begins. RFCs are more comprehensive than ADRs and are used to gather feedback from the broader team. A single RFC can lead to multiple ADRs as the design is refined into concrete decisions.
adr/ Architecture Decision Records
└─ assets/ Diagrams and images referenced by ADRs
rfc/ Requests for Comments
└─ assets/ Diagrams and images referenced by RFCs
- Create a new file in the
adr/orrfc/directory. - Name it with the next available number and a short description:
001-<name>.md. - For ADRs, follow the MADR template.
- Open a pull request for review.
RFCs are open for discussion and feedback from all contributors. Use the pull request review process to comment, suggest changes, and iterate on the proposal.
ADRs require approval from the Platform Mesh Technical Steering Committee (TSC), who are the code owners of this repository. An ADR is considered accepted once the pull request is approved and merged.
