docs: clarify module and profile boundaries #117

Merged
nimmo merged 1 commit from feat/clarify-module-boundaries into main 2026-07-28 10:06:22 +01:00
Owner

Closes #113

Summary

  • correct the README repository tree and composition diagram
  • define the intended boundaries for modules, profiles, hosts, NixOS users, Home Manager, helpers, and packages
  • record current intentional boundary cases and defer focused reshaping to #111, #114, and #115
  • preserve the existing architecture without introducing Dendritic or flake-parts

Validation

  • nix flake check
  • nix fmt -- --ci
  • git diff --check
Closes #113 ## Summary - correct the README repository tree and composition diagram - define the intended boundaries for modules, profiles, hosts, NixOS users, Home Manager, helpers, and packages - record current intentional boundary cases and defer focused reshaping to #111, #114, and #115 - preserve the existing architecture without introducing Dendritic or flake-parts ## Validation - `nix flake check` - `nix fmt -- --ci` - `git diff --check`
docs: clarify module and profile boundaries
All checks were successful
AI pull-request review / review (pull_request) Successful in 2m11s
04c6d4989b
Author
Owner

Automated code review

Reviewed commit: 04c6d4989bfbe024e4a8bd14971848c0e5505210

Verdict: Ready to merge

No blocking or important findings were retained, and deterministic checks passed. Suggestions remain advisory.

Overall assessment

Documentation-only update to README.md that clarifies module, profile, host, and user boundaries. The PR removes the deprecated hosts/common/ path from the directory tree, simplifies the import chain visualization into a generalized template, and introduces an explicit Architecture Rules and Boundary Decisions section. It aligns documentation with the current multi-host NixOS flake structure and defers structural refactoring to tracked issues (#111, #114, #115).

Blocking findings

None.

Important findings

None.

Suggestions

None.

Tests and validation

  • No configured deterministic checks.

Questions

  • Should the referenced issues (#111, #114, #115) be explicitly linked in the PR description or MR template to ensure reviewers can easily track the deferred boundary clarifications alongside this documentation update?

Review limitations

  • Review is based solely on the provided diff; actual Nix evaluation (nix flake check) and formatting validation were not executed locally.
  • Documentation accuracy was assessed against internal consistency within the diff, but live deployment behavior or module import resolution was not verified.

Diff coverage

  • README.md: reviewed — included in a context-limited batch
Review metadata
  • Reviewer: forgejo-ai-review v1
  • Model: qwen3.6:35b-a3b-q8_0
  • Guidance loaded: .forgejo/ai-review.md, .forgejo/ai-review.yml, AGENTS.md, README.md
  • Commits considered: 1
  • Previous automated review: none found
  • Findings: 0
<!-- forgejo-ai-review:v1 --> ## Automated code review Reviewed commit: `04c6d4989bfbe024e4a8bd14971848c0e5505210` ## Verdict: Ready to merge No blocking or important findings were retained, and deterministic checks passed. Suggestions remain advisory. ### Overall assessment Documentation-only update to README.md that clarifies module, profile, host, and user boundaries. The PR removes the deprecated hosts/common/ path from the directory tree, simplifies the import chain visualization into a generalized template, and introduces an explicit Architecture Rules and Boundary Decisions section. It aligns documentation with the current multi-host NixOS flake structure and defers structural refactoring to tracked issues (#111, #114, #115). ### Blocking findings None. ### Important findings None. ### Suggestions None. ### Tests and validation - No configured deterministic checks. ### Questions - Should the referenced issues (#111, #114, #115) be explicitly linked in the PR description or MR template to ensure reviewers can easily track the deferred boundary clarifications alongside this documentation update? ### Review limitations - Review is based solely on the provided diff; actual Nix evaluation (nix flake check) and formatting validation were not executed locally. - Documentation accuracy was assessed against internal consistency within the diff, but live deployment behavior or module import resolution was not verified. ### Diff coverage - `README.md`: **reviewed** — included in a context-limited batch <details><summary>Review metadata</summary> - Reviewer: forgejo-ai-review v1 - Model: qwen3.6:35b-a3b-q8_0 - Guidance loaded: .forgejo/ai-review.md, .forgejo/ai-review.yml, AGENTS.md, README.md - Commits considered: 1 - Previous automated review: none found - Findings: 0 </details>
nimmo merged commit b33ed3310c into main 2026-07-28 10:06:22 +01:00
Sign in to join this conversation.
No reviewers
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
nimmo/nixos-config!117
No description provided.