Contribute an example

An example is one directory. Adding one changes nothing outside it — there is no navigation file to edit, no index to update, no configuration to touch.

What we are looking for

• A complete arc42 documentation — all twelve sections, even where a section only says "not documented in the original". A partial documentation is a snippet, and snippets belong on docs.arc42.org.
• A real system. Anonymised is fine; invented is not.
• Clear provenance: who wrote it, under what licence, and permission to republish it here. This is the one thing a pull request cannot be merged without.

How

1. Fork the repository.
2. make new-system SLUG=your-system — this copies _systems/_TEMPLATE/ and fixes the one line that names the directory.
3. Fill in index.md first. Its front matter is the dashboard tile.
4. Write the twelve sections. Images go in your directory's images/; anything you converted from (AsciiDoc, PlantUML, drawio) goes in _originals/, which is kept for provenance and never published.
5. make dev, look at it, then open a pull request.

Markdown is canonical

Whatever the documentation was written in, the Markdown in this repository becomes the source of truth once it is merged. Examples are snapshots and are not synchronised with their originals, so there is nothing to round-trip — which is why the site needs no conversion step at build time and runs on plain GitHub Pages.

House rules for the writing

• Keep the arc42 section titles. Readers navigate by them.
• Say when something is missing rather than deleting the section. An honest gap is useful to someone comparing examples.
• No colour-coding of your own — the site is deliberately neutral and its only colour is the spine.