The Event Provenance Registry (EPR) documentation will follow the Diátaxis Framework wherever it makes sense.
| Name | Description |
|---|---|
| Tutorials | Tutorials (getting started) |
| How-to | How-to Guides (step by step solutions) |
| Reference | Reference Documentation (descriptions of the system) |
| Explanations | Explanations (ADR, Enhancement Requests, SIG) |
Tutorials are learning oriented. The idea is to get the users started with practical steps.
The how-to guides are problem/solution oriented. They take the reader through a series of steps to solve a specific problem or create a solution.
Reference documentation is information oriented. They represent the technical descriptions of the machinery and how to run it. How to use Key classes, functions, and APIs. Reference material explains things like "this is how the GraphQL front end works".
Explanations are understanding oriented. They discuss the background and context of the architecture, decisions made, research that was done, and the pros and cons of things. Discussions explain why things are the way they are.