Audit our error messages for the new markdown check
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 106
- Forks
- 223
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 72
Description
checkMarkdown.ts now has a few new checks and merges others we used to have into one. A downside of this is our error messages are less descriptive than before to avoid them being too noisy. For example, look at https://github.com/Qiskit/documentation/pull/3870.
In this issue, read our README and the error message in checkMarkdown.ts to ensure we're giving adequate instructions to content writers.
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
Read the repository README and inspect the error messages in checkMarkdown.ts, then compare the current wording with the behavior described in pull request 3870. Identify messages that do not give content writers adequate instructions and update them while preserving the consolidated checks. Done means the messages clearly explain the required correction without unnecessary noise.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100