miniobs example docs out of date
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 19
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
Description
We dropped crossbar from the requirements.txt in #173, which sort of breaks the miniobs example if followed from a fresh install. It should be made clear that crossbar needs to be installed before step 1, or that one should run a crossbar server in a Docker container (as the Sphinx docs instructs.) This likely will be made clear once #208 is merged, but just to track that this gets updated.
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 with the miniobs example documentation and compare its fresh-install steps with the Sphinx documentation's Docker instructions. Update the instructions so users know to install crossbar before step 1 or run a crossbar server in Docker; done when the example works from a fresh install without relying on issue #208.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100