docs(merge-queue): restructure metrics page heading hierarchy#68
Open
samgutentag wants to merge 1 commit into
Open
docs(merge-queue): restructure metrics page heading hierarchy#68samgutentag wants to merge 1 commit into
samgutentag wants to merge 1 commit into
Conversation
The metrics page was flagged in Slack as "too flat" — every section rendered at the same depth in the right-rail TOC because the whole page started at ### with no ## anchors. Mintlify exposes no TOC depth setting, so the fix lives in the source. Three conversion patterns: - ### → ## for top-level sections (7) - #### → ### for real subsections (13) - #### → **Sub-topic.** paragraph leads for sub-section emphasis within an h3 (Understanding the Data, Requirements, Datadog steps, example-query labels, table/code block lead-ins) Heading shape: was 7×h3 + 13×h4 + 2×h5; now 7×h2 + 13×h3 + 0×h4+. No anchor slugs changed — inbound links remain valid. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
/merge-queue/administration/metricsas "too flat" — the right-rail TOC rendered every section at the same depth.###with zero##anchors. Mintlify nests###under their parent##; with no parents, the TOC was a flat list.###and use bold paragraph leads for sub-section emphasis within an###.merge-queue/with the same rule.What changed
### → ##(7 sections).#### → ###(13 subsections).####and bold-as-headers — both replaced with bold paragraph leads in three patterns:**Sub-topic.** Body continues...under Understanding the Data and Requirements.**Label:**lead-ins for tables (Query parameters) and code blocks (Queue health alerts, Failure analysis, Duration analysis, Sample output).**1. Step**,**2. ...**for the Datadog Agent procedure.Heading shape
Anchor slugs unchanged — internal links (parallel-queues, reference/merge) and changelog inbound links (
#filter-metrics-by-impacted-targets,#prometheus-metrics-endpoint,#drill-down-into-metrics) all still resolve.Test plan
🤖 Generated with Claude Code