Add tables of contents to documentation files #30

Open
opened 2026-09-07 17:34:52 +00:00 by Xeplosion · 0 comments
Owner

Where is the problem?

Top-level Markdown documentation on the docs branch, including:

  • README.md
  • WORKFLOW.md
  • ISSUES.md
  • LABELS.md
  • PULL_REQUESTS.md

and future documentation files where a TOC materially improves navigation.

Type of documentation issue

Structural — documentation should be reorganized or relocated

What should change?

Add a consistent Table of Contents near the beginning of each applicable Markdown documentation file.

Each TOC should:

  • link to the document's major headings;
  • reflect the actual heading hierarchy;
  • remain concise enough to scan;
  • be updated when major sections are added, removed, or renamed.

Short files where a TOC provides no meaningful navigational value may omit one.

This change should not alter unrelated policy content.

Source of truth / validation

Current Markdown heading structure and Forgejo Markdown heading anchors.

Additional context

This is a navigation and usability cleanup for the docs branch.

Request checklist

  • I identified the documentation location or clearly described where the new documentation belongs
  • I described the intended corrected or improved content

Workflow lifecycle

Triage

  • Kind/ classification confirmed
  • Issue validity reviewed and appropriate Reviewed/ label assigned
  • Priority/ assigned when appropriate
  • Applicable Branch/ label(s) assigned when branch targeting matters
  • Information requirements resolved; no Status/Needs More Info remains
  • Status/Needs Triage removed before leaving Triage

Backlog

  • Issue is confirmed valid and accepted into the project backlog

To Do

  • Scope and expected outcome are sufficiently defined
  • Known prerequisites, dependencies, and required decisions are resolved or understood
  • Work has been deliberately selected as upcoming work

In Progress

  • Assignee or active owner identified when appropriate
  • Forgejo timer started when time tracking provides meaningful value
  • Relevant implementation, research, or work notes recorded as needed
  • Forgejo timer stopped when active work ends, pauses, or becomes blocked

Review Gate

  • Review requirement assessed based on complexity, criticality, reversibility, and impact
  • If review is required: moved to In Review and appropriate testing / validation performed
  • If review is required: review comment records what was reviewed, how it was validated, findings, and outcome
  • If review is not required: rationale is evident from the low-risk nature of the change

Completed

  • Acceptance criteria / intended outcome satisfied
  • Related PRs, commits, documentation, or external changes linked where applicable
  • Final resolution comment explains what changed, how the issue was resolved, and how it was verified
  • Follow-up work split into separate issues where appropriate
  • Any Forgejo timer is stopped and recorded time is final
  • Issue moved to Completed and closed
### Where is the problem? Top-level Markdown documentation on the `docs` branch, including: * `README.md` * `WORKFLOW.md` * `ISSUES.md` * `LABELS.md` * `PULL_REQUESTS.md` and future documentation files where a TOC materially improves navigation. ### Type of documentation issue Structural — documentation should be reorganized or relocated ### What should change? Add a consistent Table of Contents near the beginning of each applicable Markdown documentation file. Each TOC should: * link to the document's major headings; * reflect the actual heading hierarchy; * remain concise enough to scan; * be updated when major sections are added, removed, or renamed. Short files where a TOC provides no meaningful navigational value may omit one. This change should not alter unrelated policy content. ### Source of truth / validation Current Markdown heading structure and Forgejo Markdown heading anchors. ### Additional context This is a navigation and usability cleanup for the `docs` branch. ### Request checklist - [x] I identified the documentation location or clearly described where the new documentation belongs - [x] I described the intended corrected or improved content ### Workflow lifecycle ### Triage - [x] `Kind/` classification confirmed - [x] Issue validity reviewed and appropriate `Reviewed/` label assigned - [x] `Priority/` assigned when appropriate - [x] Applicable `Branch/` label(s) assigned when branch targeting matters - [x] Information requirements resolved; no `Status/Needs More Info` remains - [x] `Status/Needs Triage` removed before leaving Triage ### Backlog - [x] Issue is confirmed valid and accepted into the project backlog ### To Do - [ ] Scope and expected outcome are sufficiently defined - [ ] Known prerequisites, dependencies, and required decisions are resolved or understood - [ ] Work has been deliberately selected as upcoming work ### In Progress - [ ] Assignee or active owner identified when appropriate - [ ] Forgejo timer started when time tracking provides meaningful value - [ ] Relevant implementation, research, or work notes recorded as needed - [ ] Forgejo timer stopped when active work ends, pauses, or becomes blocked ### Review Gate - [ ] Review requirement assessed based on complexity, criticality, reversibility, and impact - [ ] If review is required: moved to **In Review** and appropriate testing / validation performed - [ ] If review is required: review comment records what was reviewed, how it was validated, findings, and outcome - [ ] If review is not required: rationale is evident from the low-risk nature of the change ### Completed - [ ] Acceptance criteria / intended outcome satisfied - [ ] Related PRs, commits, documentation, or external changes linked where applicable - [ ] Final resolution comment explains what changed, how the issue was resolved, and how it was verified - [ ] Follow-up work split into separate issues where appropriate - [ ] Any Forgejo timer is stopped and recorded time is final - [ ] Issue moved to **Completed** and closed
Xeplosion added reference docs 2026-09-07 17:34:57 +00:00
Sign in to join this conversation.
No milestone
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
XeplosionTechnologies/.forgejo#30
No description provided.