Vite review - #179
Draft
wdower wants to merge 8 commits into
Draft
Conversation
The schema-docs generator only tabulated object defs, so a named enum def (e.g. Content_Type) rendered as just a heading + description — hiding that it is an enum and which values are legal. Emit an "Enum — allowed values" block for enum defs in both the Types and Embedded Primitives sections. Restores values for 80 named enum renderings across the 7 schema pages. Signed-off-by: Will <will@dower.dev>
Field-table "Type" cells that reference a named schema type now render as clickable intra-page anchor links to that type's definition — a reader can "pull the thread" from a field to what its type is (and, for enums, its allowed values from the prior commit). Emit deterministic explicit {#id} heading anchors and link only to types present on the page (unknown/cross-page refs stay plain code — never a broken anchor); array/oneOf/anyOf-wrapped refs link via recursion. Extract the pure render helpers to site/schema-render.mjs and add a node:test harness (site test:ts, 10 tests) — the docs site had no tests before.
Signed-off-by: Will <will@dower.dev>
The schema-doc generator emitted a primitive's group heading (### <slug>) and
its single contained type's explicit {#anchor} with the same id whenever the
file slug matched the type's kebab name (affected-package / Affected_Package).
VitePress rejects the duplicate id and fails the entire site build. Namespace
the group heading's anchor as #primitive-<slug>; cross-links target the type
anchors, so they are unaffected.
Signed-off-by: Will Dower <will@dower.dev>
Add a docs-site page listing every converter the CLI ships, mirroring 'hdf convert --help'. The page is generated at site-build time from a committed manifest (site/data/converters.json) that a Go golden test in hdf-cli emits and verifies against the live registry — so adding or removing a converter fails the test until the manifest is regenerated, and the published catalog can never drift from what the CLI actually supports. A closing section points SBOM inventory users (SPDX, CycloneDX inventory, AIBOM) to 'hdf system create', since those formats build an HDF System document rather than Results and so never appear in the converter registry. Its accepted --from list is registry-derived (bomFormatAliases) and golden-tested alongside the converters, so it can't drift either. The generated page is git-ignored like the schema pages; the sidebar picks it up automatically. The release skill's docs-accuracy review now cross-checks the catalog against the registry each release. Signed-off-by: Will Dower <will@dower.dev>
Merging main brought new/changed converters (spdx-vex, trivy-to-hdf, and others) into the registry, staling site/data/converters.json. Regenerated via 'go test ./cmd/hdf/cmd -run TestConverterCatalogManifest -update-catalog' so the drift-guard (TestConverterCatalogManifest) passes and the published catalog lists the current converter set. The rendered page is git-ignored and rebuilt from this manifest at site-build time. Signed-off-by: Will Dower <will@dower.dev>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Catchall PR for reviewing and refining the Vitepress site.
Some cursory clicking around the site already revealed some things I wanted to fix.