rl-institut / rl-institut/simbev
Set up readthedocs
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 13
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
The docs are from the rli template and should be changed to explain simbev.
Update: The docs do exist, but are only showing correctly on rtd in the version latest. The stable version shows the template instead
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
Review the existing Read the Docs configuration and documentation generated from the rli template; compare the latest and stable builds. Update the docs to describe simbev and ensure the stable version renders simbev content rather than the template, then verify both versions on Read the Docs.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100