Migrate `.rst` Document Under `docs/source` to `.md`
Open
Nobody has claimed this yet.
Priority-P2
Type-documentation
- Dominant language
- Python
- Stars
- 502
- Forks
- 58
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 57
Description
As discussed internally, the team agreed to migrate the document from .rst to .md for better agentic integration.
Currently, all the .rst files are under docs/source.
Related link:
- Sphinx markdown support: https://www.sphinx-doc.org/en/master/usage/markdown.html
Related isse:
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 by listing the .rst files under docs/source and consult related issue #565 to identify which document is intended. Read the linked Sphinx Markdown support guidance, then migrate that document to Markdown; done means the intended document is converted and the documentation remains usable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100