Docs: Fix rst leftover errors
Open
Nobody has claimed this yet.
Documentation
Task
- Dominant language
- Python
- Stars
- 598
- Forks
- 168
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 86
Description
After migrating the docs to markdown, there is still some fair amount of documents with rst leftover errors.
Some common pattern observed:
- admonitions blocks without indentation
- a lot of backticked words (
`some-word`) were internal links before. That's a bit hard to distinguish now and is the least automatable IHO. - stuff with
:something:, which I think are different kinds of linksgrep -rE ':[a-z]+:' staging_docs/ - stuff with
{something}. Mostly{class}, which reference generated code API doc:grep -rE '\{[a-z_\-]+\}`' staging_docs/
Contributor guide
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 in staging_docs/ by running the two grep commands in the issue to inventory :something: and {something} remnants, then inspect the surrounding migrated Markdown for unindented admonitions and backticked words. Done means the identified RST leftovers in the documentation have been reviewed and corrected without leaving the reported patterns behind.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100