<detail> in docs hides too much valuable information

Open

#138 opened on Apr 25, 2025 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty: 4/5
Estimated time: 3-5 days
Newbie friendliness: 35/100

Issue type: Documentation
Clarity: Needs clarification
Activity status: Stale
Tech stack: cpp
Domain: documentation

Research direction

Start with docs/overview.md at lines 190-222 and inspect the surrounding collapsed sections to understand how the example is currently presented. Define a clearer navigation or presentation approach that keeps the valuable information discoverable; done means the example is no longer buried under several levels of disclosure without removing useful detail.

Written by the indexing model from the issue text.

Description

I found https://github.com/bemanproject/execution/blob/9cd2e66ba312c4396ac222868cc0486891cfa30b/docs/overview.md?plain=1#L190-L222
completely by accident. This is an important example buried under several levels of ▶

Documentation being too verbose isn't a problem that needs a solution, in my opinion. Navigation is a separate problem from presentation.

Dominant language: C++
Stars: 150
Forks: 23
Avg merge: 3d 5h
Merged PRs (30d): 9

Contributor guide

Open the contributing 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.

Similar issues

Use 4:4:4 for multichannel AVIF and HEIF gain maps Open

Difficulty 2/5 1-3 hours Newbie friendliness 70/100

google/libultrahdr#485 · Opened Sep 24, 2026
Missing tile warnings in TileMap dock display with wrong texture filter Open

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

godotengine/godot#123776 · Opened Sep 23, 2026
if(cond,a,b) treats any nonzero cond as true in every bngsim backend (ExprTk interpreter, C codegen, SSA), which contradicts docs/reference/expressions.md ('true when > 0.5') and BNG's run_network. A non-boolean condition in (-inf,0) or... Open

bug

Difficulty 1/5 Under an hour Newbie friendliness 60/100

lanl/bngsim#774 · Opened Sep 23, 2026
Delete ament_export_include_directories() and ament_export_libraries() calls Open

good first issue

Difficulty 1/5 Under an hour Newbie friendliness 90/100

ros2/rosbag2#2509 · Opened Sep 23, 2026
Delete ament_export_include_directories() and ament_export_libraries() calls Open

good first issue

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

ros2/common_interfaces#344 · Opened Sep 23, 2026

More C++ issues