Add check that page title is in sync with ToC, h1, and metadata
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 106
- Forks
- 223
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 72
Description
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)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing representative page titles across _toc.json, the H1, and the metadata at the top of each page. Define whether the allowlist applies to a whole file or specific divergences, then consider the validation entry point; done means inconsistent titles are reported unless the file is explicitly allowlisted.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100