Skip to content

Release: docs IA restructure and OpenSpec changes#103

Merged
djm81 merged 8 commits intomainfrom
dev
Mar 24, 2026
Merged

Release: docs IA restructure and OpenSpec changes#103
djm81 merged 8 commits intomainfrom
dev

Conversation

@djm81
Copy link
Copy Markdown
Contributor

@djm81 djm81 commented Mar 24, 2026

Summary

Release dev to main — docs site IA restructure, OpenSpec change infrastructure, and CI improvements.

Refs:

Scope

  • Bundle source changes under packages/
  • Registry/manifest changes (registry/index.json, packages/*/module-package.yaml)
  • CI/workflow changes (.github/workflows/*)
  • Documentation changes (docs/*, README.md, AGENTS.md)
  • Security/signing changes (scripts/sign-modules.py, scripts/verify-modules-signature.py)

Bundle Impact

No bundle source or version changes in this release.

Validation Evidence

All quality gates passed on PR #102 (3.11/3.12/3.13 matrix).

Required local gates

  • hatch run format
  • hatch run type-check
  • hatch run lint
  • hatch run yaml-lint
  • hatch run check-bundle-imports
  • hatch run contract-test
  • hatch run smart-test (or hatch run test)

Signature + version integrity (required)

  • hatch run verify-modules-signature --require-signature --payload-from-filesystem --enforce-version-bump
  • Changed bundle versions were bumped before signing
  • Manifests re-signed after bundle content changes

CI and Branch Protection

  • PR orchestrator jobs expected:
    • verify-module-signatures
    • quality (3.11)
    • quality (3.12)
    • quality (3.13)
  • Branch protection required checks are aligned with the above

Docs / Pages

  • Bundle/module docs updated in this repo (docs/)
  • Pages workflow impact reviewed (docs-pages.yml, if changed)
  • Cross-links from specfact-cli docs updated (if applicable)

Key docs changes

  • Site IA restructure: 15 files moved from flat guides/ to bundles/, authoring/, integrations/ with per-bundle collapsible navigation
  • Jekyll build parity: Added Gemfile/Gemfile.lock, jekyll-redirect-from plugin, aligned docs-pages.yml with specfact-cli
  • Docs review CI: New docs-review.yml workflow + test_docs_review.py gate for link integrity, front matter, and navigation checks
  • Redirect coverage: All moved files have redirect_from entries preserving old URLs
  • OpenSpec changes: Added 7 queued change proposals (docs-08 through docs-12, clean-code-02) and CHANGE_ORDER.md

Checklist

  • Self-review completed
  • No unrelated files or generated artifacts included
  • Backward-compatibility/rollout notes documented (if needed)

djm81 and others added 8 commits March 20, 2026 22:17
Restructure modules docs from 6 flat sections to 7 progressive sections
(Getting Started, Bundles, Workflows, Integrations, Team & Enterprise,
Authoring, Reference) with per-bundle collapsible sidebar navigation.

- Move 15 guides to bundle/authoring/integration directories
- Add jekyll-redirect-from entries for all moved URLs
- Rewrite index.md as bundle-focused landing page
- Update sidebar to 7-section nav with collapsible bundle groups
- Add Gemfile/Gemfile.lock aligned with specfact-cli docs infrastructure
- Align docs-pages workflow with specfact-cli (Ruby 3.2 + bundler build)
- Fix duplicate excludes in _config.yml

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…iles

- Add .github/workflows/docs-review.yml CI gate for link integrity checks
- Add tests/unit/docs/test_docs_review.py adapted from specfact-cli
- Fix broken relative links in moved files (bundles/, authoring/, integrations/)
- Add Gemfile and Gemfile.lock for Jekyll build parity with specfact-cli
- Update docs-pages workflow to use Ruby 3.2 + bundler (matching specfact-cli)
- Fix contract test assertions for new index.md and sidebar layout

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Move warnings import to top level and suppress too-many-return-statements
on the link resolver helper.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…restructure

docs: restructure modules site IA with per-bundle navigation
@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

@djm81 djm81 self-assigned this Mar 24, 2026
@djm81 djm81 added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 24, 2026
@djm81 djm81 linked an issue Mar 24, 2026 that may be closed by this pull request
@djm81 djm81 moved this from Todo to In Progress in SpecFact CLI Mar 24, 2026
@djm81 djm81 merged commit 61cbdd9 into main Mar 24, 2026
19 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in SpecFact CLI Mar 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

docs-06: Restructure Modules Docs Site Information Architecture

1 participant