Bootstrap some basic documentation?
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- documentation
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.
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
- Dominant language
- Python
- Stars
- 15
- Forks
- 23
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 3
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing 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.
More from learningequality/morango
-
Difficulty 3/5 1-2 days Newbie friendliness 58/100
learningequality/morango#349 ·
-
Model hierarchies using self-referential non-deferrable FKs can cause deletions to fail deserializationMay be free again @bjester claimed this 94 days ago, and no pull request is open. OpenDEV: backend P0 - critical
learningequality/morango#340 · 1 assignee ·
-
Implement DeserializeTask and StoreModelSource for streaming deserializationMay be free again @bjester claimed this 166 days ago, and no pull request is open. OpenDEV: backend TAG: new feature TAG: performance
learningequality/morango#317 · 1 assignee ·
-
P1 - important
Difficulty 3/5 1-2 days Newbie friendliness 45/100
learningequality/morango#308 · 1 comment ·
-
Serialization into store does not update _self_ref_fk for existing recordsMay be free again @bjester claimed this 94 days ago, and no pull request is open. OpenDEV: backend P0 - critical
learningequality/morango#305 · 1 assignee ·
All issues in learningequality/morango
Similar issues
-
bug status/needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
prowler-cloud/prowler#12887 · 1 comment ·
Maintainers usually reply within 1 day
-
area: desktop platform: macos priority: p3 status: ready type: enhancement
Difficulty 1/5 Under an hour Newbie friendliness 92/100
use-agent-os/agent-os#3484 ·
Maintainers usually reply within 2 days
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
open-telemetry/opentelemetry-python-contrib#5113 · 2 comments · 2 reactions ·
Maintainers usually reply within 1 day
-
external
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
langchain-ai/docs#6255 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day