Changelog ToC cluttered with subtitles
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 2
- Forks
- 17
- Avg merge
- 7d 18h
- Merged PRs (30d)
- 3
Description
problem: As a user of changelog, I usually want to inspect a specific or set of versions and I expect to use the ToC to only navigate through the releases. The additional titles (RESTAPI > Bugfixes, etc) in the ToC get in the way of navigating through the versions.
expectation: What I would expect is that they are hidden from the ToC so I it shows only the release versions. Of course, they still show in the changelog itself.
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 locating how the changelog table of contents is generated and how subtitle headings such as “RESTAPI > Bugfixes” are included. Confirm the current navigation output, then make the ToC show only release versions while keeping subtitles visible in the changelog itself.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100