Repository navigation
[Content] Let a registry entry set its document's sidebar and breadcrumb name - #160
Merged
Merged
Conversation
The sidebar generator named every document by title-casing its folder, so an abbreviated folder such as cle-freezing-screening showed up as "Cle Freezing Screening" in the sidebar and breadcrumbs. An optional sidebar_label on the document's docConfig entry now overrides that.
Review workflowPurpose: content · Classification: code
Next: Administrator: inspect and merge after CI passes Completed stages persist until an administrator restarts them. Replies and resolved threads are not approval requirements. Use This PR has merged. Production deployment follows the main approval process. |
usace-rmc-docs-review
Bot
changed the title
usace-rmc-docs-review
Bot
added
purpose:content
stage:needs-lane
|
@USACE-RMC/docs-admin — classify this PR with |
Collaborator
Author
|
/review classify code - |
usace-rmc-docs-review
Bot
added
stage:ready-to-merge
|
@USACE-RMC/docs-admin — review requirements are satisfied. Inspect the changes, fill document attribution manually, and merge when CI passes. |
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
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.
Description
scripts/generateSidebars.jsnames each document's sidebar group — which also feeds its breadcrumbs — by title-casing the document's folder name. That works for spelled-out folders, but an abbreviated folder comes out wrong:cle-freezing-screeningshows as "Cle Freezing Screening" in the sidebar and breadcrumbs of the new System Response Library manuals (#151–#159), andcontinuation-screeningloses its "(Filter Evaluation)".This adds an optional
sidebar_labelfield to a document'ssrc/docConfig.jsentry. When it is set, the sidebar generator uses it; when it is not, the existing title-cased folder name is used, so every current document is unchanged. The field is documented in the header comment ofdocConfig.js.The ten new System Response manuals (#150–#159) each set
sidebar_labelon their own registry entry, for example "Concentrated Leak Erosion Freezing Screening". Their previews will show the corrected names once this merges andmainis merged into those branches.Document scope
doc_location, or-):-Related issue(s)
None.
Validation
DOCS_MODE=prod npm run buildpasses. Built together with the Freezing manual's branch, its sidebar and breadcrumbs read "Concentrated Leak Erosion Freezing Screening" and "Cle" no longer appears. No registry entry onmainsetssidebar_label, so no existing sidebar changes.Review notes
Code-only:
/review classify code -.