labthings / labthings/labthings-fastapi
Diagrams in documentation`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 9
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
There are a few places where some diagrams might be helpful. For example, we could illustrate our specific flow of HTTP messages, and possibly show the relationship between different bits of LabThings a bit more visually too. I suspect Mermaid would do a nice job of this, and I believe it integrates into Sphinx.
It would be nice to add some diagrams, particularly of the HTTP communication. While we do our best to follow the WoT standard, said standard allows a fair bit of wiggle room in the "protocol binding" so it would be useful to be clear about how we are currently implementing it.
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
No documentation file or test is named. Start by locating the existing documentation and the implementation of LabThings' HTTP protocol binding, then review how Mermaid integrates with Sphinx. Done means adding diagrams that clearly explain the HTTP message flow and relevant LabThings relationships.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fastapi, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100