learningequality / learningequality/morango
Bootstrap some basic documentation?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15
- Forks
- 23
- PR merge metrics
- No merged PRs in 30d
Description
We already have a docs skeleton, would it be beneficial to expand it a bit?
Am thinking the scope could be that:
Someone with use for Morango or an intention to contribute to it, can understand what it is and how to use it (outside of Kolibri, too).
This shouldn't change that the scope of Morango is to benefit Kolibri, but just expand a potential that people can contribute to it in various ways!
- Design of sync'ing model + some words on consistency
- General integration with any app
- Specific integration with Kolibri
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
The issue names no files, tests, or entry points; start by reviewing the existing documentation skeleton and the material on the sync model and consistency. Done means adding clear guidance for general app integration and Kolibri integration so users and contributors can understand Morango outside Kolibri.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100