Skip to content

Put the docs sidebar back on the docs site's section spine - #156

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

docs.cosyte.com cannot deploy while @cosyte/dicom 0.1.0 is the current release. The site's deploy-build IA gate (cosyte/docs Dispatch receiver run 36196140266) grades each package's current release sidebar, and this one fails it:

ERROR (STRICT) IA040 dicom@v0.1.0: Top-level category label "Diagnosing & limits" is not on the canonical spine
ERROR (STRICT) IA060 dicom@v0.1.0: missing first-use entry "Installation"
ERROR (STRICT) IA060 dicom@v0.1.0: missing first-use entry "Quickstart"

What changes

Top level before: intro, installation (bare doc), quickstart (bare doc), Core Concepts, Guides, Diagnosing & limits

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

This package's own docs-content-structure test forbids a category whose label repeats the name of any page, so the three pages whose title or sidebar label matched a category label are renamed:

page before after
installation title and sidebar "Installation" "Install and verify"
quickstart title and sidebar "Quickstart" title "Read your first DICOM object", sidebar "Your first object"
troubleshooting sidebar "Troubleshooting" sidebar "Symptoms and causes" (title unchanged)

Page ids, file names and URLs do not change, so every inbound link still resolves.

Verification

  • The docs site's own runLint (from cosyte/docs scripts/check-ia-conformance.ts, strict mode) over pnpm pack:docs output staged as the current version slot: base reproduces the three errors above, this branch reports OK: all checked packages conform to the IA spine. The fetcher's sidebar doc-id validation passes too.
  • pnpm test (including test/docs-content-structure.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. The fix reaches the site through the v0.1.0 release's docs-content.tar.gz, repacked from the release commit plus this change.

https://claude.ai/code/session_01U24bnHKNxQWMxmfN7ny7w9

docs.cosyte.com cannot deploy while @cosyte/dicom 0.1.0 is the current release: the site's
deploy-build IA gate grades each package's current release sidebar, and this one fails it
(cosyte/docs Dispatch receiver run 36196140266):

  IA040 dicom@v0.1.0: top-level category "Diagnosing & limits" is not on the canonical spine
  IA060 dicom@v0.1.0: missing first-use entry "Installation"
  IA060 dicom@v0.1.0: missing first-use entry "Quickstart"

The site allows only Overview, Installation, Quickstart, Core Concepts, Guides and
Troubleshooting as top-level category labels, in that order, and requires top-level
Installation and Quickstart categories that reach a doc.

This package's own structure test forbids a category whose label repeats the name of any
page, which is why the installation and quickstart pages sat at the top level as bare docs.
Both rules hold now: the canonical categories are back, and the three pages whose title or
sidebar label matched a category label are renamed:

  installation: "Installation" becomes "Install and verify"
  quickstart: "Quickstart" becomes "Read your first DICOM object" (sidebar "Your first object")
  troubleshooting: sidebar label "Troubleshooting" becomes "Symptoms and causes"

"Diagnosing & limits" becomes Troubleshooting with the same two pages. Page ids, file names
and URLs do not change, so every inbound link still resolves.

No changeset: docs-content/ is not in the npm tarball, so the published package does not
change. The fix reaches the site through the v0.1.0 release's docs-content.tar.gz, repacked
from the release commit plus this change.

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