Skip to content

v1.0.1: documentation cleanup#41

Merged
foadshafighi merged 3 commits into
mainfrom
release/v1.0.1
Jul 10, 2026
Merged

v1.0.1: documentation cleanup#41
foadshafighi merged 3 commits into
mainfrom
release/v1.0.1

Conversation

@foadshafighi

Copy link
Copy Markdown
Contributor

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 via source_document_ref, record-relative expiry, status disqualifiers, and the sustainability_metric fields); 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_version is unchanged.

One docs/how-it-works.md section was retitled, so an external deep link to the old #validation-and-the-computed-conformance-level anchor will break (noted in CHANGELOG.md).

…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.
@foadshafighi foadshafighi requested a review from a team as a code owner July 10, 2026 03:43
@github-actions

Copy link
Copy Markdown

Codex Automated Code Review

Code Review Summary

PR: 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)

  • docs/authoring-patterns.md:68 incorrectly says internally illuminated signs are never asked for sign-face luminance. The full-tier rubric requires test-report-backed luminance for every self-emitting sign, including internally illuminated signs. Clarify that luminance is non-gating at standard for this mode but required at full.
  • docs/authoring-patterns.md:66 and tools/validator/README.md:17 imply dedicated emergency luminaires replace the architectural-photometry profile with the sign/emergency dataset. The implementation retains the normal profile, removes only luminaire efficacy, and adds emergency gates. Describe exit signs and emergency luminaires separately.
  • tools/validator/README.md:17 says tier detail is suppressed unless --verbose. Default output includes conformance/gap and grade findings; only enrichment, observations, and per-theme achievement details are hidden. Correct the visibility statement.

P2 - Medium Priority Issues (Consider Fixing)

  • SECURITY.md:38SECURITY.md:45 defines “latest tagged release” and “most recent minor version” as separately supported, although the latest release normally belongs to the most recent minor. State precisely whether the project supports only the latest patch, every release in the current minor, or both the current and previous minor branches.

P3 - Low Priority Issues (Optional)

None found.

Positive Observations

  • The PR remains documentation-only and introduces no schema, generated-index, workflow, or taxonomy drift.
  • All 259 cross-file schema references resolve successfully.
  • The new achievement guidance correctly documents record-relative expiry, status disqualifiers, evidence hashes, and the restricted-substances sibling flag.

Automated review by OpenAI Codex

@greptile-apps

greptile-apps Bot commented Jul 10, 2026

Copy link
Copy Markdown

Greptile Summary

A docs-only patch release (v1.0.1) that brings the narrative documentation 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 one canonical home per datum with cross-links everywhere else.

  • docs/authoring-patterns.md gains two new authoring sections: exit-sign/emergency-class records (covering the exit_sign block, the electrical re-gate, the emergency block, UL 924 attestation, and the core-to-standard gap) and achievement attestations (evidence, record-relative expiry, status disqualifiers, the sustainability_metric payload, and the restricted_substances_declared flag); the now-stale planned-validator-checks list is removed.
  • docs/how-it-works.md renames the validation section from "Validation and the computed conformance level" to "Validation and the two computed views" to reflect both grading axes; all inbound links from README.md, methodology.md, and authoring-patterns.md have been updated to the new anchor.
  • SECURITY.md replaces the pre-1.0 placeholder policy with the actual post-1.0 two-version support window; CHANGELOG.md documents the one external-link break introduced by the anchor rename.

Confidence Score: 5/5

Docs-only change; no schema, taxonomy, example records, Go code, or CLI behavior was modified.

Every cross-file anchor link introduced or updated in this PR was verified against the target section headings (how-it-works.md#validation-and-the-two-computed-views, methodology.md#the-two-grading-axes-completeness-and-achievements, compliance-attestation.md#achievement-themes, methodology.md#product-class-profiles-exit-signs-and-emergency-luminaires, and others). The companion ulcspec.org site was also checked and contains no references to the old renamed anchor. The SECURITY.md policy update correctly delivers the commitment made in the pre-1.0 text it replaces. No logic, schema, or executable artifact was touched.

No files require special attention.

Important Files Changed

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.
@github-actions

Copy link
Copy Markdown

Codex Automated Code Review

Code Review Summary

PR: 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)

  • SECURITY.md:38-45 contradicts itself: the “most recent minor version” includes older tags such as 1.0.0, while the table says all “Older tagged releases” receive no fixes. Replace these overlapping labels with explicit supported ranges such as 1.0.x, and clarify whether every patch in that line or only its latest patch is supported.

P3 - Low Priority Issues (Optional)

None found.

Positive Observations

  • New authoring guidance agrees with the schema, grader rules, and committed emergency examples.
  • Achievement evidence, expiry, status, and generated-index behavior are documented accurately.
  • No restricted-standards text, schema changes, hand-authored indexes, or research/ files were introduced.
  • All 259 schema $ref pointers resolve. The Go suite could not run because the read-only environment prevented creation of Go’s build cache.

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.
@github-actions

Copy link
Copy Markdown

Codex Automated Code Review

Code Review Summary

PR: 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

  • New behavioral descriptions match the schema, examples, and Go implementation.
  • Achievement evidence, expiry, and status-disqualification rules are documented accurately.
  • Exit-sign grading details match the committed Cooper records.
  • All 259 cross-file $ref pointers resolve.
  • No schema, workflow, generated-index, or research/ changes were introduced.
  • New internal documentation links resolve to valid headings.

Automated review by OpenAI Codex

@foadshafighi foadshafighi merged commit 86109bc into main Jul 10, 2026
4 checks passed
@foadshafighi foadshafighi deleted the release/v1.0.1 branch July 10, 2026 04:26
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