The IRS documentation is build and published by the GitHub workflow Lint and Publish documentation automatically.
In order to build the documentation locally for testing adjustments to the documentation the script build-docs-locally.sh can be used.
| Folder | Description |
|---|---|
| concept | Concepts including a template for concepts. |
| src/api | See README. |
| src/diagram-replacer | Scripts that create images from PlantUML diagrams and replace them in the documentation, when the documentation is published via GitHub workflow. |
| src/docs | The sources for the Item Relationship Service Documentation |
| src/docs/administration | The sources for the IRS Administration Guide. |
| src/docs/api-specification | The source for the IRS REST API Documentation published by the github workflow. |
| src/docs/arc42 | The sources for the IRS Architecture Documentation (based on the arc42 template). |
| src/docs/security | Documentation relevant for security assessment. |
| src/post-processing | Some post-processing used by the GitHub workflow. |
| src/uml-diagrams | UML diagrams for the documentation |
| target | The output directory for the documentation build. |