diff --git a/README.md b/README.md index 2338997c..9b47d6fb 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,32 @@ # Standards Library -Reusable engineering standards with routed workflows, profiles, topics, and -non-normative reference material. +Reusable engineering guidance for deciding how to plan, build, verify and maintain software. -Canonical applicability and dependency selection are owned by the -[Standards Router](STANDARDS-ROUTER.md). This README is a repository entrypoint; -it does not select modules or establish canonical ownership. +The library covers shared principles, task workflows, language and application profiles, and focused topics such as security, concurrency and accessibility. Its Router selects the guidance that applies to the work in front of you, so you can read the relevant material rather than the entire library. -## Start Here +## Start here 1. Read [Core Standards](CORE-STANDARDS.md). -2. Use the [Standards Router](STANDARDS-ROUTER.md) to select guidance from - observable task and repository facts. -3. Record project-specific contracts and exceptions in the adopting - repository through the selected canonical owners. +2. Use the [Standards Router](STANDARDS-ROUTER.md) with observable facts about your task and repository. +3. Record project-specific contracts and exceptions in the adopting repository through the selected canonical owners. -Unknown applicability is a Router diagnostic. Do not read every document, -select guidance from this README, or use a linked module as fallback authority. +The Router owns applicability and dependencies. If applicability is unknown, resolve that diagnostic there; a link in this README does not select a module or make it authoritative. -## Resources - -These links are non-normative repository resources. Their presence does not -establish applicability or ownership. +## Useful starting points - [README template](templates/README-TEMPLATE.md) - [Plan template](templates/PLAN-TEMPLATE.md) - [Pull request template](templates/PULL_REQUEST_TEMPLATE.md) -## Maintaining This Repository +Templates are resources, not substitutes for the Router's selected guidance. + +## Tools and maintenance + +The standards can be read directly; there is no application to launch. For agent navigation, controlled authoring and verification, see the [Standards Engine](tools/standards_engine/README.md) and its [connection setup](.agents/skills/standards-engine/references/environment.md). -- [Active work](docs/plans/README.md) and [completed work](docs/archive/README.md) -- [Architecture decisions](docs/decisions/README.md) -- [Standards Engine](tools/standards_engine/README.md) -- [Verification commands](tools/standards_verifier/README.md) -- [Evaluation evidence and fixtures](evaluation/standards-effectiveness/README.md) +[Verification commands](tools/standards_verifier/README.md) cover registered structural checks and separate implementation tests. Passing them does not certify the prose or a downstream project's compliance. -These non-normative resources describe repository maintenance and history. +[Active work](docs/plans/README.md) · [Completed work](docs/archive/README.md) · [Architecture decisions](docs/decisions/README.md) · [Evaluation evidence](evaluation/standards-effectiveness/README.md) -## License +[CC0 1.0 Universal](LICENSE). -Repository license terms are in [LICENSE](LICENSE). diff --git a/evaluation/standards-effectiveness/generated/suite-inputs.json b/evaluation/standards-effectiveness/generated/suite-inputs.json index b391480c..335569d4 100644 --- a/evaluation/standards-effectiveness/generated/suite-inputs.json +++ b/evaluation/standards-effectiveness/generated/suite-inputs.json @@ -13,6 +13,18 @@ } ] }, + { + "digest": "sha256:418191d37a77028f7e287b165f9ee69eee20f8207af5a4f5ba7f792f0fcfae06", + "path": ".agents/skills/standards-engine/references/environment.md", + "state": "present", + "uses": [ + { + "check": "root-links", + "role": "link-target", + "suite": "root-index-closure" + } + ] + }, { "digest": "sha256:ccbee12ecf276efc4e8d54b6ca839daadb1b4f94a034efa0b745d5733e999e13", "path": "ARCHITECTURE-PATTERNS.md", @@ -560,7 +572,7 @@ ] }, { - "digest": "sha256:f39750d097bd6477d6d2ad36595557fe4c5ab4686b661aa7db970900d26ddd5d", + "digest": "sha256:e27c1148994fb26d2e6052df574f6fb5b0c5cd4c9077e5331df1f53188782619", "path": "README.md", "state": "present", "uses": [