Skip to content
Agon ĀtriumAgon Ātrium

Source code

Open source page

Documentation guidance

  • Present Agon Atrium in README.md as a product of Agon Partners Innovation AG. Keep the introduction short and link to detailed documentation.
  • Keep end-to-end application onboarding in docs/integration/getting-started.md, local publication behavior in docs/integration/publishing.md, first-page customization in docs/integration/first-page.md, and reusable component guides in docs/components/. Explain required settings and backend responsibilities before optional extensions.
  • Keep setup, source layout, quality commands, and helper explanations in docs/development/setup.md. Keep the integration reading map in docs/integration/README.md and dedicated backend, theming, manual bootstrap, and deployment procedures alongside it, and reproducible acceptance checks in docs/development/verification.md.
  • Keep each paragraph and list item on one physical line. Never use semicolons in prose. End the sentence with a period and start the next with an uppercase letter. Apply the same rule to source comments and JSDoc.
  • Keep README badges above the title with exactly one complete badge link per source line, matching the sibling Agon repositories. The Markdown-specific Prettier override preserves these line breaks and aligned table columns. Never collapse the badge block into a single line.
  • Keep README previews in docs/images/. Use viewport screenshots of the actual production showcase from the passing browser suite, with descriptive alt text and links to full-size images. Do not use full-document captures for pinned navigation, which is sized to the viewport. Refresh previews after material visual changes using the verification procedure.
  • Begin prose bullets with an uppercase letter where practical and end every item with a period, including parent items introducing nested lists. Keep tables valid and consistently padded.
  • Give maintained Markdown documents Author and Version sections. Use the established Laurent Declercq author line and a YYYYMMDD document version. Update that version when changing the document.
  • Exempt CHANGELOG.md from author/date metadata because it uses release versions. The repository-wide prose punctuation rules still apply.
  • Follow the changelog grammar in root AGENTS.md. Describe user-visible changes and compatibility effects, without inventing released versions or dates.
  • Run yarn lint:prose after Markdown or source-comment changes. The syntax-aware gate excludes executable statements, strings, inline/fenced code, and explicit JSDoc examples.
  • Keep command examples verified, explicit about their working directory and prerequisites, and clear about output and process shutdown.
  • Link to the canonical procedure instead of copying it across documents. Agent instructions and skills must link to the same human documentation.

Author

Laurent Declercq l.declercq@agon-innovation.ch

License

Unless otherwise stated all source code is licensed under LGPL 2.1 and has the following copyright:

© 2026, Agon Partners Innovation AG, All rights reserved.

The design material and the “Agon Ātrium” trademark is the property of their authors. Reuse of them without prior consent of their respective authors is strictly prohibited.

Version

Version: 20260921