Skip to content

docs: align validation scope, supported systems and wording - #31

Merged
Miguel-DevOps merged 1 commit into
mainfrom
docs/align-validation-scope-and-metadata
Nov 16, 2026
Merged

Miguel-DevOps merged 1 commit into
mainfrom
docs/align-validation-scope-and-metadata

Conversation

@Miguel-DevOps

Copy link
Copy Markdown
Contributor

This pull request updates the project branding and documentation to reflect the new "Developmi Hardened" name, clarifies the scope and validation status, and improves the structure and accuracy of the README and supporting files. The changes focus on aligning terminology, updating compliance language, and providing a clearer, more detailed overview of the project's capabilities and validation evidence.

Branding and Naming Updates:

  • Changed all references from "NIST-Compliant Hardening Suite" to "Developmi Hardened" across documentation and configuration files, including .ansible-lint, .yamllint, CONTRIBUTING.md, and README.md. [1] [2] [3] [4]

Documentation Structure and Clarity:

  • Rewrote and reorganized the README.md to use clearer section headings, a more detailed table of contents, and improved descriptions of features, value proposition, validation scope, compliance mapping, and operational instructions. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14]

Compliance and Validation Language:

  • Updated compliance statements to say "mapped to" NIST 800-53 (instead of "compliant"), clarified that Tailscale provides private mesh networking (not "zero trust"), and specified that the project does not claim full zero trust architecture. [1] [2] [3] [4]
  • Added explicit details about the validation scope: production validation is limited to Debian 12 and Ubuntu 22.04 on up to 2 Brain and 10 Muscle nodes; scale tests and other OSes are not confirmed. [1] [2]

Role and Maintainer Updates:

  • Updated maintainer's role to "Infrastructure & DevSecOps Consultant" and revised the description of responsibilities and philosophy throughout the documentation. [1] [2]

Changelog and Contributor Docs:

  • Added a changelog entry summarizing the documentation rewrite, scope clarification, compliance language changes, and README section reordering.

These changes collectively improve project clarity, transparency, and professional presentation for contributors and users.

- Replace Production Ready with scoped production status and validation scope
- Restrict supported systems to Debian 12 and Ubuntu 22.04
- Map to NIST 800-53 and CIS instead of claiming compliance
- Describe Tailscale as a private mesh; cite NIST SP 800-207 by its official title
- Document SOPS + age as the secrets mechanism
- Reorder README closing sections and fix contact role
- Updated GLOSSARY.md to clarify terminology and definitions, including changes to Zero Trust and Private Mesh.
- Revised README.md to specify the framework's alignment with NIST 800-53 for Debian 12 and Ubuntu 22.04.
- Modified ARCHITECTURE.md to reflect the updated compliance mapping and architectural details, including the removal of references to unsupported OS versions.
- Adjusted LAYER_BOUNDARIES.md to align with the current OS support and architecture.
- Enhanced ADR-05.md with an amendment regarding the scope of supported OS versions.
- Updated COMPLIANCE-MAPPING-STATUS.md to clarify the status of various compliance frameworks and their implementation.
- Revised INDEX.md to reflect the updated terminology regarding NIST SP 800-207.
- Adjusted NIST_800_53.md to clarify compliance status and related documents.
- Updated PRODUCTION_ACCEPTANCE.md to specify validation criteria for production readiness.
- Revised FINOPS-BASELINE.md to clarify metrics and impacts of the transition to self-hosted solutions.
- Adjusted BACKUP_STRATEGY.md to clarify the scope of the backup engine.
- Updated COMPATIBILITY_MATRIX.md to reflect the current state of OS support and testing.
- Revised DEVELOPER_SETUP.md to clarify common issues and resolutions.
- Updated ROADMAP.md to reflect changes in planned releases and future implementations.
- Adjusted DEVELOPER_WORKSTATION_GUIDE.md to reflect the shift from Zero Trust to Private Mesh model.
- Revised HARDENING-STATUS.md to clarify the security baseline for developer and operator workstations.
@Miguel-DevOps
Miguel-DevOps merged commit 75138f0 into main Nov 16, 2026
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant