oppia / oppia/oppia-web-developer-docs
Add wiki page reading roadmap to the getting started guide
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 18
- Forks
- 133
- PR merge metrics
- No merged PRs in 30d
Description
In the getting started guide, we should tell new contributors when they should read what pages of the wiki. The reading progression should generally be:
- Pages that everyone should read
- For each team, the pages that everyone on that team should read
- How to find more niche pages that can be read as-needed (e.g. the technical reference pages)
We could also spell out, somewhere, a way for contributors to know "where they are now skill-wise and what issues they can do now / what they should learn next". (Maybe this can be shown visually on the main page, as an image.)
Contributor guide
No contributing guide indexed for this repository
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 locating the getting started guide and the relevant wiki pages. Define the reading progression from universally required pages, through team-specific pages, to as-needed technical references, and decide whether the skill-level guidance belongs in the guide or as a visual on the main page. Done means contributors can identify what to read next and which issues match their current skills.
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