Skip to content
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.

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

Request: stable sub-heading IDs on combined configuration settings pages #770

Closed
kenjenkins opened this issue Jun 26, 2023 · 0 comments · Fixed by #777
Closed

Request: stable sub-heading IDs on combined configuration settings pages #770

kenjenkins opened this issue Jun 26, 2023 · 0 comments · Fixed by #777

Comments

@kenjenkins
Copy link
Contributor

Page: https://www.pomerium.com/docs/reference/cookies (as one example)

What's incorrect or missing

The auto-generated heading IDs for all the "How to configure" and "Examples" sub-headers are numbered like -1, -2, -3:

If I send someone a link such as How to configure Cookie HTTP Only and we later add a new option before this one, my link will no longer point to the 'Cookie HTTP Only' section.

What's the resolution?

Should we set these IDs explicitly? For example:

### How to configure {#cookie-name-how-to-configure}

(cf. https://docusaurus.io/docs/next/markdown-features/toc#heading-ids)

Alternatively, should these not be linkable at all? I think we could manually insert <h3> tags instead:

<h3>How to configure</h3>

If I understand correctly, then they wouldn't be linkable, and they wouldn't appear in the right-hand table-of-contents, which is looking a little cluttered to me:

Screen Shot 2023-06-26 at 11 34 10 AM
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 a pull request may close this issue.

1 participant