AcademySoftwareFoundation / AcademySoftwareFoundation/OpenPBR

Table of Contents section numbers

Open
#279 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
CSS
Stars
793
Forks
44
PR merge metrics
No merged PRs in 30d

Description

This is minor, but the Table of Contents has section numbers that don't always match what's below. For example, the Table of Contents has a link that says:

> [3.2.3 Subsurface](https://academysoftwarefoundation.github.io/OpenPBR/#model/basesubstrate/subsurface)

Although the number in the ToC here says 3.2.3, the section it leads to is numbered 3.7.3.

In fact it appears that there are no sections numbered 3.1 to 3.5. Section [3 Model](https://academysoftwarefoundation.github.io/OpenPBR/#model) is followed immediately by section [3.6 Microfacet Model](https://academysoftwarefoundation.github.io/OpenPBR/#model/microfacetmodel) which is labeled as 3.1 in the ToC.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start from the OpenPBR document linked in the issue and compare its Table of Contents entries with the linked section headings, especially Subsurface and Microfacet Model. Correct the inconsistent section numbers in the document source, then verify that the ToC labels and linked headings match.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.