Skip to content

revisited doc on table of contents #2522

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
parmentelat wants to merge 4 commits into
base: main
Choose a base branch
from
Open

revisited doc on table of contents #2522

parmentelat wants to merge 4 commits into from
+103 −51

Conversation

@parmentelat
Copy link
Contributor

@parmentelat parmentelat commented Dec 1, 2025

primarily trying to better expose the discussion on slug generation, that was hidden in a section called 'implicit TOC', but slugification happens all the time, not only when no TOC is provided

@changeset-bot
Copy link

changeset-bot bot commented Dec 1, 2025 •
edited
Loading

⚠️ No Changeset found

Latest commit: 918a67b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 1, 2025
bsipocz
bsipocz approved these changes Dec 3, 2025
View reviewed changes
Copy link
Contributor

@bsipocz bsipocz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for making these restructuring. I left a few wordsmithing comments, take them or leave them and until someone with write access can come and merge the PR.

@parmentelat
Copy link
Contributor Author

parmentelat commented Dec 3, 2025

took comments into account, and added quite a few more slug examples
all observed on v1.6.7

@parmentelat parmentelat force-pushed the doc/table-of-contents branch from b0d0b10 to 918a67b Compare December 4, 2025 09:12
@parmentelat
Copy link
Contributor Author

parmentelat commented Dec 4, 2025 •
edited
Loading

rebased on top of current main

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@bsipocz bsipocz bsipocz approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

PR triage (experimental)
Status: No status

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@parmentelat @bsipocz