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

Add check that page title is in sync with ToC, h1, and metadata #2489

Open
Eric-Arellano opened this issue Dec 16, 2024 · 0 comments
Open

Add check that page title is in sync with ToC, h1, and metadata #2489

Eric-Arellano opened this issue Dec 16, 2024 · 0 comments

Comments

@Eric-Arellano
Copy link
Collaborator

You have to set the page title in three places:

  • _toc.json
  • H1, i.e. starting with #
  • Metadata at the top of the page

It's actually quite useful that these three can be different values. However, ~90% of the time, we want them to be in sync. We should require allowlisting if they are not in sync.

Background for this idea: someone was confused why searching for the _toc.json title was not resulting in the page showing up.

allowlisting

TBD the best approach to do this. The allowlist will need to be the file name. But do you only list the file to say it's okay for them to diverge, or do you have to get more granular to say which of the 3 are divergent? (Imo the former is less confusing and better)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

1 participant