Developing and maintaining Atrium
This section is for contributors changing the shared theme, publisher, starter, showcase, or repository tooling. Run its commands from the Atrium repository root unless a procedure explicitly uses an isolated test directory. To build your own product frontend using the published package, use application integration.
Start development
Follow setup and commands to install the pinned workspace dependencies and run the showcase or starter. Use the showcase’s /components pages to exercise reusable components. The starter verifies that the same package can support a smaller independent application.
Both applications use workspace:* inside this repository so maintainers can develop Atrium and its examples together. This dependency form is internal to the monorepo. Released applications use a version from the remote npm registry.
Maintainer reading path
- Read architecture for package boundaries, application lifecycle, and state ownership.
- Follow coding standards and the relevant agent guidance when changing maintained source or documentation.
- Update the shared feature, its component contract, dedicated component guide, and showcase example together.
- Run the verification procedure, including isolated package consumption when packaging or public integration changes.
- Follow CI and releases for the local verification graph and the separate hosted package-publication process.
Use asset provenance when changing showcase media or documentation screenshots. The verification record preserves the earlier dated results and limitations. It is not proof that your current checkout passes.
Use online documentation and public showcase hosting for publication metadata, static artifacts, Docker Bake, Coolify environments, release downloads, and rollback.
Documentation ownership
Keep application instructions under docs/integration/, reusable component reference under docs/components/, and maintainer procedures here. The documentation index is the entry point for both audiences. Put local package archives and disposable application tests in verification instructions, not in the normal installation walkthrough.
Keep current commands in these maintained guides. Update the changelog for user-visible documentation changes.
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