nginx / nginx/nginx.org

Subdirectives are not properly indented in the TOC

Open
#137 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
XSLT
Stars
89
Forks
60
Avg merge
19h 11m
Merged PRs (30d)
12

Description

Feature Overview

Some Nginx modules define new configuration blocks with a bunch of directives there, e.g. http://nginx.org/en/docs/http/ngx_http_upstream_module.html (and there many more examples in N+).

It would be helpful to see such subdirectives indented in the TOC, i.e. instead of

Directives
    upstream
    server
    zone
    state
    ...

it should be

Directives
    upstream
        server
        zone
        state
        ...
Alternatives Considered

No response

Additional Context

No response

Contributor guide

Open the contributing guide

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

Start by locating the documentation TOC generation entry point and inspect how directive nesting is represented for NGINX modules such as the upstream module. Confirm the current flat output and trace where parent-child relationships are available. Done means subdirectives such as server, zone, and state render indented beneath upstream in the TOC.

Written by the indexing model from the issue text.

Assessment

Tech stack
nginx
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.