From 2d94723c477b117245b976b9655c032d368da61d Mon Sep 17 00:00:00 2001 From: Noah Schatz Date: Fri, 25 Sep 2026 22:48:31 +0000 Subject: [PATCH] Put the docs sidebar back on the docs site's section spine 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 --- docs-content/installation.md | 6 +++--- docs-content/quickstart.md | 6 +++--- docs-content/sidebars.json | 14 +++++++++++--- docs-content/troubleshooting.md | 2 +- 4 files changed, 18 insertions(+), 10 deletions(-) diff --git a/docs-content/installation.md b/docs-content/installation.md index 3ec607a..028a91d 100644 --- a/docs-content/installation.md +++ b/docs-content/installation.md @@ -1,10 +1,10 @@ --- id: installation -title: Installation -sidebar_label: Installation +title: Install and verify +sidebar_label: Install and verify --- -# Installation +# Install and verify `@cosyte/dicom` is a metadata-first DICOM Part 10 parser for Node.js/TypeScript. It ships dual **ESM + CJS** builds with per-condition type declarations, so it works from either module system diff --git a/docs-content/quickstart.md b/docs-content/quickstart.md index af4f7ce..ccea7de 100644 --- a/docs-content/quickstart.md +++ b/docs-content/quickstart.md @@ -1,10 +1,10 @@ --- id: quickstart -title: Quickstart -sidebar_label: Quickstart +title: Read your first DICOM object +sidebar_label: Your first object --- -# Quickstart +# Read your first DICOM object This page gives you a first useful result: read a DICOM Part 10 object and pull out **who the patient is**, **what the study/series is**, and the **image geometry** you need before touching a diff --git a/docs-content/sidebars.json b/docs-content/sidebars.json index 5f48ba6..9c85e6c 100644 --- a/docs-content/sidebars.json +++ b/docs-content/sidebars.json @@ -1,8 +1,16 @@ { "docs": [ "intro", - "installation", - "quickstart", + { + "type": "category", + "label": "Installation", + "items": ["installation"] + }, + { + "type": "category", + "label": "Quickstart", + "items": ["quickstart"] + }, { "type": "category", "label": "Core Concepts", @@ -22,7 +30,7 @@ }, { "type": "category", - "label": "Diagnosing & limits", + "label": "Troubleshooting", "items": ["troubleshooting", "limitations"] } ] diff --git a/docs-content/troubleshooting.md b/docs-content/troubleshooting.md index 2d78a5a..58a1ae3 100644 --- a/docs-content/troubleshooting.md +++ b/docs-content/troubleshooting.md @@ -1,7 +1,7 @@ --- id: troubleshooting title: "Troubleshooting: symptoms and causes" -sidebar_label: Troubleshooting +sidebar_label: Symptoms and causes --- # Troubleshooting: symptoms and causes