haskell / haskell/cabal

Cabal user guide's page titles and breadcrumbs wrong/misleading

Open
#6,797 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

The user guide displays the heading of the first section of every page as the title for the entire page both as the title of the tab and in the breadcrumbs. However this is wrong, because most pages contain multiple sections of equal rank. For example if you go to [*3. Package Concepts and Development*](https://www.haskell.org/cabal/users-guide/developing-packages.html) the title is *3.1 Quickstart* which is wrong, because the same page also contains *3.2 Package concepts* and *3.3 Developing packages*. I found this rather confusing when I was looking for a reference of all possible package attributes and figured that it's probably not in the “Quickstart” section.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.