Redo README
Open
Nobody has claimed this yet.
documentation
help wanted
- Dominant language
- Python
- Stars
- 12
- Forks
- 11
- Avg merge
- 7d 23h
- Merged PRs (30d)
- 3
Description
Update README and design docs. We can use docs folder for seq diagrams and use https://sequencediagram.org for changing them(use txt files). We have an old version of this internally, but if we make it public it would just be misleading because too much changed
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 reviewing the current README and the docs folder, including any existing sequence-diagram text files, then compare them with the present project rather than publishing the old internal version. Done means the README, design documentation, and diagrams accurately describe the current system without misleading outdated content.
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