Problems to read the documentation

Open
#416 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
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
css
Domain
documentation

Research direction

Start by opening the Boost.Test documentation main page and the linked “Declaring and organizing tests” page, then inspect how their navigation hierarchy and link styles are generated. Done means the relevant sub-hierarchy, including “Operations on dataset,” is visible and visited links are distinguishable from unvisited links.

Written by the indexing model from the issue text.

Description

Hello,

I am trying to learn Boost.Test from the documentation, and I am facing to two problems :

  1. The main page doesn't show all the hierarchy's depth ; and when I select, for example, Declaring and organizing tests, that doesn't show either all the sub-hierarchy (the content of Operations on dataset doesn't appear)

  2. Because of CSS, the visited links have same color than not visited links.

Is is so very easy to feel lost , and as I can't read this big documentation in one go, to know where to resume my reading.

Dominant language
C++
Stars
213
Forks
149
Avg merge
18h 17m
Merged PRs (30d)
2

Contributor guide

No contributing guide indexed for this repository

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 boostorg/test

All issues in boostorg/test

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.