letsencrypt / letsencrypt/cp-cps

GitHub anchor links and Website anchor links are different

Open
#300 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
38
Forks
26
PR merge metrics
No merged PRs in 30d

Description

When using github to render the markdown, section anchor links look like #32-initial-identity-validation.

However, the section anchor links on our website have dots between their numbers, like 3.2-initial-identity-validation.

This means that all of the anchor links in use currently work correctly on github but not on the website. We should see if we can change the way the website generates heading anchors to match the way github does it, so the same links work in both locations.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the heading anchors in CP-CPS.md with the anchors generated on the linked website page, starting with how the website renders document headings. Confirm the desired GitHub-compatible format and verify that existing links resolve correctly in both locations when done.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.