openedx / openedx/docs.openedx.org
Headers are rendering as hyperlinks
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 35
- Forks
- 95
- Avg merge
- 5d 15h
- Merged PRs (30d)
- 3
Description
On some docs (I will add links to examples after a PR Merge), the headers are rendering as hyperlinks.
This is not a breaking error, per se, but it is a new change and out of line with how they used to render.
Issue is to determine the pattern for why this is happening and resolve, if possible.
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 by inspecting the documentation pages where headers render as hyperlinks and compare them with pages whose headers render normally. The issue mentions that examples will be linked after a pull request merge, but provides no files, tests, or page links; done means identifying the rendering pattern and restoring consistent header rendering if possible.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100