Remove duplicate H1 headings matching frontmatter titles in index.mdx files

[Copilot]

This PR addresses the issue of redundant H1 headings in documentation files that duplicate the frontmatter title property.

Problem

Many index.mdx files across the documentation had duplicate H1 headings that exactly matched their frontmatter title field. This created redundant content where the same title appeared twice - once from the frontmatter (used by the page layout) and once as an explicit H1 heading in the markdown content.

Solution

Created and executed a Python script that:

• Parses YAML frontmatter from all 299 index.mdx files in contents/docs/
• Identifies files where the first H1 heading matches the frontmatter title (case-insensitive)
• Removes the duplicate H1 heading while preserving all other content and formatting

Results

• 196 files were automatically fixed, removing duplicate H1 headings
• All files maintain their frontmatter titles for proper page rendering
• Content flows more naturally without redundant headings
• Build and linting processes continue to work correctly (all 195 pages still generate successfully)

Examples of fixes

• title: "Undoing Changes" + # Undoing Changes → removed duplicate H1
• title: "Creating Branch" + # Creating Branch → removed duplicate H1
• title: "Detached Head" + # Detached HEAD → removed duplicate H1 (handled case differences)

Impact

The documentation now has a cleaner, more professional structure with no redundant headings. Each page displays the title from frontmatter only, eliminating confusion for readers and improving the overall user experience.

Fixes #237.

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
learn-git-with-me	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 8, 2025 7:53am

[spaciousejar]

don't touch the title

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Join our Discord community for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.