Skip to content

📝 docs(platforms): fix RST formatting and TOC hierarchy#447

Merged
gaborbernat merged 1 commit intotox-dev:mainfrom
gaborbernat:docs-fix-platforms-v2
Feb 15, 2026
Merged

📝 docs(platforms): fix RST formatting and TOC hierarchy#447
gaborbernat merged 1 commit intotox-dev:mainfrom
gaborbernat:docs-fix-platforms-v2

Conversation

@gaborbernat
Copy link
Copy Markdown
Member

@gaborbernat gaborbernat commented Feb 15, 2026

The platforms documentation had RST formatting issues that affected the table of contents structure. 📌 A leftover "Default paths" header in the preamble with no corresponding section content has been removed to clean up the introduction.

Platform-specific sections (macOS, Windows, Linux/Unix, Android) were using dashes (---) which render as level-2 headers, incorrectly appearing as main sections in the TOC. ✨ These are now level-3 headers (using ~~~) to align them logically with "User directories" and "Shared directories" subsections they precede.

The result is a cleaner, more intuitive table of contents that better reflects the actual documentation structure.

The "Default paths" section header was leftover text that wasn't actually
a section. Removed it to clean up the preamble.

Platform-specific sections (macOS, Windows, Linux/Unix, Android) were using
dashes (---) which render as level-2 headers, making them appear as main
sections in the TOC. Changed to tildes (~~~) to render as level-3 headers,
which aligns them with "User directories" and "Shared directories" subsections
where they logically belong.
@gaborbernat gaborbernat requested a review from ofek as a code owner February 15, 2026 22:09
@gaborbernat gaborbernat merged commit 1d8448b into tox-dev:main Feb 15, 2026
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant