Skip to content

docs(contributing): drop the emoji from section headings so the TOC anchors resolve - #1486

Open
lxcxjxhx wants to merge 1 commit into
AgentOps-AI:mainfrom
lxcxjxhx:docs/strip-heading-emoji
Open

lxcxjxhx wants to merge 1 commit into
AgentOps-AI:mainfrom
lxcxjxhx:docs/strip-heading-emoji

Conversation

@lxcxjxhx

Copy link
Copy Markdown

Follow-up to #1485, as offered there.

Every ## heading in app/CONTRIBUTING.md carries a leading emoji. GitHub removes the emoji and keeps the space that followed it as a hyphen, so:

## 🚀 Getting Started

renders as id="user-content--getting-started" — two hyphens — while the table of contents links to #getting-started. Nine entries in that table were dead:

#code-of-conduct, #getting-started, #development-setup, #making-changes, #submitting-changes, #code-style, #documentation, #community, and #testing.

Stripping the emoji makes every id match its link.

What is not touched: the ## lines inside the ```markdown fence under "Pull Request Template" (## Description, ## Type of Change, ## Testing, …). Those are template text, not rendered headings — and leaving them alone is also what keeps #testing pointing at the real section rather than at the template copy.

Verification: the repo's anchor checker on app/ before and after:

before:  app/CONTRIBUTING.md -> #code-of-conduct, #getting-started, #development-setup,
         #making-changes, #submitting-changes, #code-style, #documentation, #community, #code-style
after:   (none)

The four hits that remain under app/ (#external-services-setup, three × #development-setup) are what #1485 fixes; this branch is based on the same main, so they still show here.

…nchors resolve

Every `##` heading in this file carries a leading emoji. GitHub removes the emoji and keeps the
space that followed it as a hyphen, so

    ## 🚀 Getting Started

renders as `id="user-content--getting-started"` — two hyphens — while the table of contents
links to `#getting-started`. Nine entries in that table were dead.

Stripping the emoji makes the ids match the links. The `##` headings inside the ```markdown
fence under "Pull Request Template" are untouched: they are template text, not rendered
headings.

Verified with the repo's own anchor checker before and after: `app/CONTRIBUTING.md` goes from
nine bad anchors to none.

This branch has not been deployed

No deployments
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.

1 participant