Skip to content

docs: align release-facing docs with v1.1.0 posture#22

Merged
GsCommand merged 1 commit into
mainfrom
codex/align-release-facing-documentation-for-v1.1.0
Mar 20, 2026
Merged

docs: align release-facing docs with v1.1.0 posture#22
GsCommand merged 1 commit into
mainfrom
codex/align-release-facing-documentation-for-v1.1.0

Conversation

@GsCommand
Copy link
Copy Markdown
Contributor

Motivation

  • Remove release-facing placeholder wording and ensure all public docs present v1.1.0 as the current release and active schema line.
  • Eliminate language that overclaims signed or cryptographic provenance and replace it with precise, procedural publication metadata references.
  • Make HTTPS hosting vs IPFS publication separation and checksum-based integrity the consistent, authoritative framing across release-facing docs.

Description

  • Rewrote release-status and publication wording across README.md, SECURITY_PROVENANCE.md, SCHEMAS.md, and RESOLUTION.md to remove placeholder PENDING exposure and state that a v1.1.0 CID is recorded in manifest.json when published to IPFS.
  • Tightened integrity language in SECURITY.md to describe immutable versioned directories, checksum-based integrity, documented release metadata, and that semantic changes require a new version, and replaced an overbroad “all schemas pinned” claim.
  • Replaced vague provenance guidance in CONTRIBUTING.md with explicit instructions to update RESOLUTION.md, manifest.json, and checksum artifacts when the release process requires it.
  • Adjusted CHANGELOG.md wording to avoid attestation-style phrasing and clarified that TypeScript examples and npm vs repo artifact distinctions remain illustrative and not CI-validated; left COMPLIANCE.md, GOVERNANCE.md, ONBOARDING.md, and SPEC.md unchanged after review.

Testing

  • Ran npm run validate, which invokes validate:schemas and validate:examples, and the schema compilation and example validations completed successfully.
  • Example validation finished with per-version summaries reported and no blocking validation errors for the changed documentation surface.
  • Verified repository state with git status --short before committing the documentation updates.

Codex Task

@GsCommand GsCommand merged commit 367d1c1 into main Mar 20, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant