isocpp / isocpp/CppCoreGuidelines
Markdown: jump in references don't match header line anchors
Open
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 45.3k
- Forks
- 5.6k
- PR merge metrics
- No merged PRs in 30d
Description
In the central
CppCoreGuidelines.md
the jump references to headers don't match the reference anchors of the headers.
I didn't check all but ,e.g.,
https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#S-expr
should point to
instead.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with CppCoreGuidelines.md and inspect the jump references to headers, comparing each target anchor with the corresponding header line. Use the S-expr example in the issue as the model, update mismatched references, and verify that the links point to the intended headers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100