Better error message in title/metadata check
Open
Nobody has claimed this yet.
infra 🏗️
- Dominant language
- Jupyter Notebook
- Stars
- 106
- Forks
- 223
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 72
Description
At the moment, the title / metadata check shows errors like this:
Error in file 'docs/guides/get-started-with-sampler.ipynb':
- Mismatch: frontmatter title "Get started with Sampler" does not match heading "Get started with primitives"
We should also include instructions on how to ignore mismatches (that is, adding the file to https://github.com/Qiskit/documentation/blob/main/scripts/config/allowLists.ts#L24)
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 with the title/metadata check that emits the shown error for docs/guides/get-started-with-sampler.ipynb, and read scripts/config/allowLists.ts at the linked location. Update the error output to explain how to ignore a mismatch by adding the file there; done means the reported error includes those instructions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, typescript
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100