Add architecture decision records - #225
Open
somethingwithproof wants to merge 4 commits into
Open
Conversation
Item 8 was inserted between item 7's link and its description paragraph, which re-parents that paragraph onto Architecture Decisions. Move item 8 below the Development Standards description. Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
There was a problem hiding this comment.
🟢 Approval recommended
Only a minor documentation consistency nit was found; the new ADR docs and links are otherwise coherent and self-contained.
Pull request overview
Adds an initial set of Architecture Decision Records (ADRs) to document the proposed architectural direction for upcoming installer/plugin redesign work, and links them from the main documentation README so they’re discoverable.
Changes:
- Add an ADR index page (
Architecture-Decisions.md) and four initial Proposed ADRs underArchitecture/. - Link the ADR index from the documentation
README.md(including a new “Architecture Decisions” section). - Document proposed boundaries for bounded contexts, durable install runs, plugin extension contracts, and workflow state/artifact storage separation.
File summaries
| File | Description |
|---|---|
| README.md | Adds navigation entry and section linking to the ADR index. |
| Architecture-Decisions.md | New ADR index page with status definitions and links to ADR-0001..0004. |
| Architecture/0001-bounded-contexts.md | New Proposed ADR defining bounded contexts and framework-independent domain rules. |
| Architecture/0002-durable-install-runs.md | New Proposed ADR defining durable/resumable install runs with explicit lifecycle and leases. |
| Architecture/0003-plugin-extension-boundary.md | New Proposed ADR defining a versioned plugin extension boundary and lifecycle contributions. |
| Architecture/0004-workflow-storage-and-observability.md | New Proposed ADR defining separation of workflow state vs diagnostics/artifacts and secret handling. |
Review details
- Files reviewed: 6/6 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+100
to
102
| 8. [Architecture Decisions](README.md#architecture-decisions) | ||
|
|
||
| ### Known Issues |
Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a small ADR set to establish the proposed architecture direction for Cacti.
Why
The installer and plugin redesign work needs reviewable architectural decisions before implementation expands. These ADRs document the proposed boundaries while preserving an incremental, backward-compatible migration path.
Impact
Documentation only. All decisions are marked Proposed and do not change current Cacti behavior.
Validation
bin/check_missing_link.sh Architecture-Decisions.md Architecture README.mdbin/check_markdown_style.sh Architecture-Decisions.md Architecture README.mdCloses #228