Add tables of contents to documentation files #30
Labels
No labels
Compat/Breaking
Compat/Deprecation
Kind
Bug
Kind
Chore
Kind
Documentation
Kind
Enhancement
Kind
Feature
Kind
Investigation
Kind
Question
Kind
Security
Kind
Testing
Meta/Good First Issue
Meta/Help Wanted
Meta/Stale
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Reviewed
Confirmed
Reviewed
Duplicate
Reviewed
Invalid
Reviewed
Won't Fix
Status
Abandoned
Status
Blocked
Status
Needs More Info
Status
Needs Triage
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
XeplosionTechnologies/.forgejo#30
Loading…
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Where is the problem?
Top-level Markdown documentation on the
docsbranch, including:README.mdWORKFLOW.mdISSUES.mdLABELS.mdPULL_REQUESTS.mdand 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:
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
docsbranch.Request checklist
Workflow lifecycle
Triage
Kind/classification confirmedReviewed/label assignedPriority/assigned when appropriateBranch/label(s) assigned when branch targeting mattersStatus/Needs More InforemainsStatus/Needs Triageremoved before leaving TriageBacklog
To Do
In Progress
Review Gate
Completed