pomerium / pomerium/documentation

sidebar depth is not configurable

Open
#148 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

blocked docs frontend
Dominant language
MDX
Stars
13
Forks
23
Avg merge
1d 5h
Merged PRs (30d)
11

Description

What's incorrect or missing

Vuepress had a concept of sidebarDepth which would let you choose on a page by page basis how deep you wanted your right-hand sidebar to list items for. That doesn't seem to exist natively in docusaurus.

Basically, the frontmatter they have for ToC but for sidebars.

---
# Display h2 to h5 headings
toc_min_heading_level: 2
toc_max_heading_level: 5
---

What's the resolution?

Some version of sidebarDepth

Related

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.

Research direction

No implementation files or tests are named. Start by reading the linked Docusaurus table-of-contents and sidebar-depth references, then compare them with VuePress's nested header links; the work is done when page frontmatter can control the heading depth shown in that page's right-hand sidebar.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
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.