docs(mkdocs): flatten DLP entries in CLI Reference sidebar#225
Merged
Conversation
Add renderSummary() that emits docs/cli/SUMMARY.md mapping every generated page flat under its top-level group (runtime/redteam/ model-security). literate-nav consumes the SUMMARY.md, so the four runtime/dlp/* pages appear as siblings of runtime/* instead of under a nested "Dlp" group. No URLs change; only sidebar render order.
This was referenced May 28, 2026
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.
Summary
runtime dlp dictionaries,runtime dlp filtering-profiles,runtime dlp patterns, andruntime dlp profilesunder a separate "Dlp" group because mkdocsliterate-navauto-generated the nav from thedocs/cli/runtime/dlp/subdirectory. Fix: generator now writesdocs/cli/SUMMARY.mdlisting every page flat under its top-level group;literate-navconsumes it instead of inferring from directory layout.renderSummary(pages)inscripts/cli-docs/render.ts(5 new unit tests).gen-cli-docs.tswritesdocs/cli/SUMMARY.mdalongsideindex.md.Verified by inspecting
site/cli/runtime/dlp/dictionaries/index.html: pre-fix had>Dlp<label spanning 4 children; post-fix has no nested Dlp label and the 4 DLP entries appear as flat siblings under Runtime alongsideairs runtime api-keys,airs runtime dlp-gen,airs runtime dlp-profiles, etc.Side effect: the build no longer emits warnings about
cli/examples/README.md/cli/examples/REDACTION.mdbeing referenced from nav — they're not in SUMMARY.md so literate-nav stops trying to include them.Per
CLAUDE.md§ Releases this is queued as a.changeset/*.mdpatch; no version bump in this PR.Test plan
renderSummaryunit tests: groups by top-level command, DLP entries flat under Runtime, no nested "Dlp" label, pre-existing flat pages (dlp-gen, dlp-profiles) not duplicated, entries sorted alphabetically, all 3 top-level groups presentpnpm lintcleanpnpm tsc --noEmitcleanpnpm test704/704pnpm docs:checkcleanpnpm docs:buildclean (warnings about cli/examples nav references also gone as a happy side-effect)