Skip to content

Add documentation header analysis identifying 62 problematic headers#5513

Draft
Copilot wants to merge 6 commits intomainfrom
copilot/fix-markdown-headers
Draft

Add documentation header analysis identifying 62 problematic headers#5513
Copilot wants to merge 6 commits intomainfrom
copilot/fix-markdown-headers

Conversation

Copy link
Contributor

Copilot AI commented Feb 11, 2026

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:

  • 29 "What is X?" headers that don't answer their question (HIGH) - 93.5% failure rate
  • 33 generic headers ("Description", "Overview") obscuring specific content (MEDIUM)

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 recommendations
  • problematic_headers.csv - Sortable spreadsheet (Priority, File, Line, Current/Suggested Headers)
  • HEADER_FIX_GUIDE.md - Fix patterns with before/after examples
  • HEADER_ANALYSIS_START_HERE.md - Quick reference for different user roles

Reusable Analysis Scripts:

  • Header parsing and pattern detection across all markdown files
  • "What is X?" specific analysis with opening content evaluation
  • CSV generation for issue tracking integration
  • Scripts can be re-run as documentation evolves

All intermediate JSON files (10MB+) are gitignored but regenerable via scripts.

Checklist

  • Delete items not relevant to your PR

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@vercel
Copy link

vercel bot commented Feb 11, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clickhouse-docs Ready Ready Preview Feb 11, 2026 6:29pm
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
clickhouse-docs-ru Ignored Ignored Preview Feb 11, 2026 6:29pm
clickhouse-docs-zh Ignored Ignored Preview Feb 11, 2026 6:29pm

Request Review

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copilot AI and others added 5 commits February 11, 2026 18:02
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
Copilot AI requested a review from Blargian February 11, 2026 18:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants