Add documentation header analysis identifying 62 problematic headers#5513
Draft
Add documentation header analysis identifying 62 problematic headers#5513
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
|
|
Co-authored-by: Blargian <41984034+Blargian@users.noreply.github.com>
Co-authored-by: Blargian <41984034+Blargian@users.noreply.github.com>
Co-authored-by: Blargian <41984034+Blargian@users.noreply.github.com>
Co-authored-by: Blargian <41984034+Blargian@users.noreply.github.com>
Co-authored-by: Blargian <41984034+Blargian@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update markdown headers for accuracy in documentation
Add documentation header analysis identifying 62 problematic headers
Feb 11, 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
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
Analyzed 874 markdown files (10,020 sections) to identify headers that don't accurately describe their content. Delivers comprehensive reports and tooling for systematic remediation.
Analysis Results
62 problematic headers identified:
Example from
docs/cloud/features/04_infrastructure/warehouses.md:20:## What is compute-compute separation? Compute-compute separation is available for Scale and Enterprise tiers.Header asks a definition question but opens with availability info instead of answering.
Deliverables
Reports:
HEADER_ANALYSIS_REPORT.md- Full analysis with categorized issues and fix recommendationsproblematic_headers.csv- Sortable spreadsheet (Priority, File, Line, Current/Suggested Headers)HEADER_FIX_GUIDE.md- Fix patterns with before/after examplesHEADER_ANALYSIS_START_HERE.md- Quick reference for different user rolesReusable Analysis Scripts:
All intermediate JSON files (10MB+) are gitignored but regenerable via scripts.
Checklist
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.