Skip to content

Move the conformance statement into the docs Guides category - #89

Merged
NSchatz merged 1 commit into
mainfrom
docs-sidebar-ia-spine
Sep 25, 2026
Merged

NSchatz merged 1 commit into
mainfrom
docs-sidebar-ia-spine

Conversation

@NSchatz

@NSchatz NSchatz commented Sep 25, 2026

Copy link
Copy Markdown
Contributor

The docs site's deploy-build IA gate grades each package's current release sidebar, and the sidebar on main would fail it as soon as it ships in a release. Reproduced with the site's own lint over pnpm pack:docs output at 9c339c1:

ERROR (STRICT) IA040 mllp@v0.1.0: Top-level category label "Conformance" is not on the canonical spine

A red gate there stops every docs.cosyte.com deploy, not only this package's pages (cosyte/docs Dispatch receiver run 36196140266 is the same failure for three other packages), and this is the sidebar the next release packs.

What changes

The conformance statement moves from its own top-level category into Guides, after the testing page. That is where @cosyte/ccda already keeps its conformance page. test/docs/structure.test.ts requires sidebar_position to ascend in sidebar order, so the statement takes 9 and the limitations page, now last, takes 10. The statement stays in the sidebar, and no page id, file name or URL changes.

Top level after: intro, Installation, Quickstart, Core Concepts, Guides, Troubleshooting

Verification

  • The docs site's own runLint (strict) over pnpm pack:docs output staged as the current version slot: base reproduces the error, this branch reports OK: all checked packages conform to the IA spine.
  • pnpm test (including test/docs/structure.test.ts and test/conformance/statement.test.ts), pnpm format:check, pnpm check:no-emdash, pnpm check:no-internal-refs, pnpm phi-scan, and the shared docs-content-check.mjs: all green locally.

No changeset: docs-content/ is not in the npm tarball, so the published package does not change.

https://claude.ai/code/session_01U24bnHKNxQWMxmfN7ny7w9

The docs site's deploy-build IA gate grades each package's current release sidebar, and
the sidebar on main would fail it the moment it ships in a release:

  IA040 mllp: top-level category "Conformance" is not on the canonical spine

(reproduced with the site's own lint over `pnpm pack:docs` output at 9c339c1). A red gate
there stops every docs.cosyte.com deploy, not only this package's pages, and this is the
sidebar the next release would pack.

The site allows only Overview, Installation, Quickstart, Core Concepts, Guides and
Troubleshooting as top-level category labels, and a label after Troubleshooting has no
canonical home. The statement moves into Guides after the testing page, which is where
@cosyte/ccda already keeps its conformance page. The docs structure test requires
sidebar_position to ascend in sidebar order, so the statement takes 9 and the limitations
page, now last, takes 10. The statement stays in the sidebar, and no page id, file name or
URL changes.

No changeset: docs-content/ is not in the npm tarball, so the published package does not
change.

Claude-Session: https://claude.ai/code/session_01U24bnHKNxQWMxmfN7ny7w9
@NSchatz
NSchatz enabled auto-merge (squash) September 25, 2026 22:50
@NSchatz
NSchatz merged commit bd3872a into main Sep 25, 2026
11 checks passed
@NSchatz
NSchatz deleted the docs-sidebar-ia-spine branch September 25, 2026 22:52
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