v1.0.1: documentation cleanup#41
Conversation
…class - authoring-patterns.md: add a product-class authoring section for exit-sign and emergency-class records and an achievement-attestation authoring section; remove the stale planned-validator-checks list. - how-it-works.md: retitle the validation section to the two computed views and bring the consumption walkthrough current for both axes. - README, methodology, the directory indexes, and the CLI READMEs: refresh for the Product Achievements axis and the exit-sign/emergency product class. - Collapse cross-doc duplication to one canonical home per datum, with a short gloss and a link from every other doc. - SECURITY.md: post-1.0 supported-versions policy. - Add the CHANGELOG 1.0.1 section and bump the README version line.
Codex Automated Code ReviewCode Review SummaryPR: Documentation currency update for v1.0.1, achievements, and emergency product classes P0 - Critical Issues (Must Fix)None found. P1 - High Priority Issues (Should Fix)
P2 - Medium Priority Issues (Consider Fixing)
P3 - Low Priority Issues (Optional)None found. Positive Observations
Automated review by OpenAI Codex |
|
| Filename | Overview |
|---|---|
| CHANGELOG.md | Adds v1.0.1 entry correctly describing the docs-only nature of the release and calling out the one external-link break (anchor rename). |
| README.md | Version bump to 1.0.1, condensed prose, new links to specific how-it-works.md anchors; all verified anchors resolve correctly in the updated how-it-works.md. |
| SECURITY.md | Replaces the pre-1.0 placeholder policy with the actual post-1.0 two-version support policy and updates the table accordingly; the deferred-to-v1.0 promise is now honoured. |
| docs/README.md | Adds compliance-attestation.md to the directory index and expands descriptions for how-it-works.md, methodology.md, and authoring-patterns.md to reflect the new sections. |
| docs/authoring-patterns.md | Adds two new authoring sections (exit-sign/emergency product class and achievement attestations) and condenses the validator-implications summary; the removed planned-checks list correctly relocates the still-valid information to methodology.md and how-it-works.md. |
| docs/compliance-attestation.md | Trims the per-theme state definitions from this file and defers them to methodology.md#the-two-grading-axes; the cross-reference resolves to a valid anchor. |
| docs/how-it-works.md | Section retitled from "Validation and the computed conformance level" to "Validation and the two computed views"; all inbound links from README.md, methodology.md, and authoring-patterns.md verified to target the new anchor correctly. |
| docs/methodology.md | Minor prose consolidation; the back-reference to how-it-works.md#validation-and-the-two-computed-views now matches the renamed section heading. |
| templates/workbook/README.md | Record count updated from five to eight and description expanded to include exit-sign/emergency product class, consistent with the rest of the docs. |
| tools/README.md | Validator description updated to include the Product Achievements axis in the ulc validate command's feature list. |
| tools/validator/README.md | Drops the "As of the next release" qualifier (now shipped), adds Product Achievements axis and class-aware grading to the feature checklist, and tightens the deferred-items description. |
Reviews (3): Last reviewed commit: "docs: set the 1.0.1 release date and cla..." | Re-trigger Greptile
- authoring-patterns.md: distinguish exit-sign grading (the sign dataset) from dedicated emergency-luminaire grading (the normal profile minus luminaire efficacy plus the emergency gates), and clarify that mode-specific sign photometrics gate by tier, so an internally illuminated sign needs a test-report-backed sign-face luminance at full. - tools/validator/README.md: describe emergency-luminaire grading separately from exit signs, and correct the output-visibility note: the level, tier roadmap, and achievements summary render by default, and only the enrichment roadmap, observation notes, and per-theme achievement detail are gated behind --verbose.
Codex Automated Code ReviewCode Review SummaryPR: Documentation updates for ULC v1.0.1, including achievements and emergency-product guidance. P0 - Critical Issues (Must Fix)None found. P1 - High Priority Issues (Should Fix)None found. P2 - Medium Priority Issues (Consider Fixing)
P3 - Low Priority Issues (Optional)None found. Positive Observations
Automated review by OpenAI Codex |
…olicy - CHANGELOG.md: date the 1.0.1 section 2026-07-10. - SECURITY.md: replace the overlapping supported-versions rows with a clear policy. The latest tagged release and the newest patch of the previous minor line receive security fixes; all other releases do not.
Codex Automated Code ReviewCode Review SummaryPR: Documentation cleanup for v1.0.1, aligning narrative documentation with Product Achievements and exit-sign/emergency grading. P0 - Critical Issues (Must Fix)None found. P1 - High Priority Issues (Should Fix)None found. P2 - Medium Priority Issues (Consider Fixing)None found. P3 - Low Priority Issues (Optional)None found. Positive Observations
Automated review by OpenAI Codex |
Docs-only patch release. Brings the narrative docs current with the 1.0.0 feature set (the Product Achievements grading axis and the exit-sign/emergency product class) and collapses cross-doc duplication to a single canonical home per datum.
Highlights
docs/authoring-patterns.md: a product-class authoring section for exit-sign and emergency-class records and an achievement-attestation authoring section (evidence viasource_document_ref, record-relative expiry, status disqualifiers, and thesustainability_metricfields); the stale planned-validator-checks list is removed.docs/how-it-works.md: the validation section is retitled to the two computed views and the consumption walkthrough is brought current for both grading axes.README.md,docs/methodology.md, the directory indexes, and the CLI READMEs: refreshed for the Product Achievements axis and the eight-record example corpus.SECURITY.md: post-1.0 supported-versions policy.Scope
No schema, taxonomy, example record, grade, index, or CLI behavior changed; every conformance grade and finding is byte-identical to 1.0.0, and the Go suite is untouched.
ulc_versionis unchanged.One
docs/how-it-works.mdsection was retitled, so an external deep link to the old#validation-and-the-computed-conformance-levelanchor will break (noted inCHANGELOG.md).