moodle / moodle/devdocs

Save useful info about question walkthrough tests from the comment in MDL-77327

Open
#565 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement help wanted needs-triage
Dominant language
TypeScript
Stars
74
Forks
652
Avg merge
2d 50m
Merged PRs (30d)
12

Description

What is the Moodle feature that needs documenting?

Well, the whole of the core_question system needs documenting. But, once that is done, we should capture (and probalby expand) the explanation I wrote in the tracker comment.

Is this documentation specific to a Moodle version?

No

Are you able to provide a patch for this?

Yes - I will create one

Contributor guide

Open the contributing guide

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 reviewing the explanation referenced in tracker issue MDL-77327 and survey the core_question system to determine the relevant documentation location. Expand and preserve the walkthrough-test information, with completion meaning the useful explanation is available in the developer documentation and covers the intended system scope.

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
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.