openlibhums / openlibhums/janeway
Add a Table of Contents header to the issue page
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 238
- Forks
- 97
- Avg merge
- 9d 1h
- Merged PRs (30d)
- 8
Description
Is your feature request related to a problem? Please describe.
Some users struggle to see the layout of the issue page itself as the Table of Contents for the given issue. This is specially important for indexing, as some indexers require displaying a table of contents to be present on the issue page. Since we are not labelling the ToC explicitely, indexers might mistakenly recognise there is no Issue ToC on Janeway.
Describe the solution you'd like
A header on the issue page that clearly labels the contents of the issue page as the "Table of Contents"
Additional context
It may need to be a configurable text, as the Chicago manual of Style recommends a different display for this label ("contents")
https://www.chicagomanualofstyle.org/dam/jcr:8763fd88-9af5-4654-99d4-49d7e0055c66/Turabian-Tip-Sheet-3.pdf
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
No file, test, or entry point is named in the issue. Start by locating the issue-page entry point, then determine how the label should be configured and verify that the rendered page clearly identifies its contents as the Table of Contents.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100