Changelog ToC cluttered with subtitles

Open
#81 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

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.

Description

enhancement

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.

image

Dominant language
HTML
Stars
2
Forks
17
Avg merge
7d 18h
Merged PRs (30d)
3

Contributor guide

Open the contributing guide

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.

More from pulp/pulp-docs

All issues in pulp/pulp-docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.