hashicorp / hashicorp/consul

Make "Jump To Section" in docs more prominent

Open
#9,605 1 comment 1 reaction 0 assignees View on GitHub
theme/operator-usability type/docs type/enhancement
Dominant language
Go
Stars
30.1k
Forks
4.6k
Avg merge
1d 18h
Merged PRs (30d)
39

Description

In the consul API documentation there is a "Jump To Section" pull down at the top of each section. For a long time I've wanted that feature but didn't notice it until today. I think it would be more helpful if made more prominent so it'd be easier to spot.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the Consul API documentation sections and the existing “Jump To Section” pull-down at the top of each section. Determine how its visibility can be improved, then verify that the control is consistently easier to notice and remains usable throughout the documentation.

Written by the indexing model from the issue text.

Assessment

Domain
design, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.