@cosyte/dicom 0.0.15 → 0.0.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +59 -0
- package/dist/index.cjs +1 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.mjs +1 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,64 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.0.16
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- ce2975a: Fold the `Known limitations` sidebar category into `Troubleshooting`, so the shipped
|
|
8
|
+
`docs-content/sidebars.json` conforms to the documentation IA spine (`DOCS-STALE-BEHIND-IA040`)
|
|
9
|
+
|
|
10
|
+
No source, no public API and no parse behaviour changes. `docs-content/limitations.md` is not
|
|
11
|
+
renamed and not moved, and the page keeps its URL, so every existing link to it still resolves. One
|
|
12
|
+
sentence of its prose changes, for the reason given under THE PAGE NO LONGER DESCRIBES ITS OWN
|
|
13
|
+
POSITION below.
|
|
14
|
+
|
|
15
|
+
WHAT SHIPS. The top level of `docs-content/sidebars.json` goes from
|
|
16
|
+
|
|
17
|
+
intro, Installation, Quickstart, [Known limitations], Core Concepts, Guides, Troubleshooting
|
|
18
|
+
|
|
19
|
+
to
|
|
20
|
+
|
|
21
|
+
intro, Installation, Quickstart, Core Concepts, Guides, Troubleshooting[troubleshooting, limitations]
|
|
22
|
+
|
|
23
|
+
`Known limitations` was never on the canonical spine, which is
|
|
24
|
+
`[Overview, Installation, Quickstart, Core Concepts, Guides, API Reference, Troubleshooting]`.
|
|
25
|
+
The spine's own definition of Troubleshooting is "common error symptoms plus how to debug, plus
|
|
26
|
+
Known Limitations if the package surfaces them", so this is the label's canonical home rather than a
|
|
27
|
+
workaround for the lint. The two docs now sit under one heading in the order a reader meets them:
|
|
28
|
+
`troubleshooting` (what went wrong) then `limitations` (what will never work).
|
|
29
|
+
|
|
30
|
+
WHY IT WAS URGENT. `docs.cosyte.com` builds the released corpus and lints each package's SHIPPED
|
|
31
|
+
sidebar against that spine, in strict mode, where a non-canonical top-level label is a hard error.
|
|
32
|
+
A finding inside an ARCHIVED release is downgraded to non-gating info, because immutable bytes have
|
|
33
|
+
no remedy diff. The same finding against the CURRENT release gates, because the remedy is exactly
|
|
34
|
+
this: cut the next release. So the label sat dormant through `v0.0.14` and became blocking the
|
|
35
|
+
moment `v0.0.15` was published and became current. It was not a new defect, and it stopped the whole
|
|
36
|
+
site rebuilding, not just this package's pages.
|
|
37
|
+
|
|
38
|
+
WHICH MEANS THE FIX ONLY LANDS ON A RELEASE. `docs` reads `docs-content/` out of the release
|
|
39
|
+
artifact (`docs-content.tar.gz`), never out of `main`, so this changeset is load-bearing rather than
|
|
40
|
+
bookkeeping: without a new version the corrected sidebar never reaches the site.
|
|
41
|
+
|
|
42
|
+
THE CATEGORY IS NOT FORCED OPEN. The deleted category carried `"collapsed": false`, and
|
|
43
|
+
`Troubleshooting` deliberately keeps the Docusaurus default instead of inheriting it. That flag
|
|
44
|
+
existed to keep a one-item category permanently expanded so `limitations` read like a top-level
|
|
45
|
+
page, a need that disappears once the page lives inside a real two-item category. `Core Concepts`
|
|
46
|
+
keeps its `"collapsed": false` because it is the five-part reading spine of the package, not a
|
|
47
|
+
destination a reader navigates to on purpose.
|
|
48
|
+
|
|
49
|
+
THE PAGE NO LONGER DESCRIBES ITS OWN POSITION. `limitations.md` opened by claiming the boundary
|
|
50
|
+
"lives high in the navigation rather than at the end of a troubleshooting page", which this change
|
|
51
|
+
makes false in the one place a reader can check it: the page is now the last item of the last
|
|
52
|
+
category, immediately after the troubleshooting page. That sentence is rewritten to say what is
|
|
53
|
+
actually load-bearing, that the boundary is a page of its own rather than a closing paragraph, and
|
|
54
|
+
that the introduction and the cookbook link into it. Left alone it would have frozen into an
|
|
55
|
+
immutable release artifact and been correctable only by cutting yet another release, which is the
|
|
56
|
+
same failure this change exists to end.
|
|
57
|
+
|
|
58
|
+
NO `API Reference` CATEGORY IS AUTHORED HERE, and none may be. The docs site injects it at the
|
|
59
|
+
canonical position (immediately before Troubleshooting) from the package's generated API set;
|
|
60
|
+
hand-authoring it is a separate hard error in the same lint.
|
|
61
|
+
|
|
3
62
|
## 0.0.15
|
|
4
63
|
|
|
5
64
|
### Patch Changes
|