oppia / oppia/oppia-web-developer-docs

Update the docs for writing schemas

Open
#390 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug Impact: Medium Work: Low
Dominant language
Python
Stars
18
Forks
133
PR merge metrics
No merged PRs in 30d

Description

Many of the details on this page are outdated, making it difficult for new users to understand, leading to confusion. Therefore, the schemas page needs to be updated.

Examples:

  • The file below does not exist.
    image

  • This code reference also does not exist.
    image

Additional issues are likely present, so a thorough review and update are necessary.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the schemas page referenced in the issue and reviewing its current examples, including the missing file and code reference shown in the screenshots. Update the page after checking which details are outdated; done means the schema-writing guidance and examples match the current documentation, with no nonexistent references remaining.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.