[docs] Create documentation for documentation (getting started template, useful tips/tricks)
Open
Nobody has claimed this yet.
documentation
enhancement
help wanted
- Dominant language
- TypeScript
- Stars
- 74
- Forks
- 652
- Avg merge
- 2d 50m
- Merged PRs (30d)
- 12
Description
What is the Moodle feature that needs documenting?
For documentation we should document some tips and tricks on getting started, for example:
- a getting started template
- useful markdown frontmatter
- links to the frontmatter docs
- useful components (Since, ValidExample, InvalidExample)
- other useful things (including examples from file, etc.)
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
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
Locate the existing developer documentation structure and comparable getting-started pages, then review how frontmatter and components such as Since, ValidExample, and InvalidExample are currently used. Done means adding a version-independent guide covering the requested template, frontmatter links and tips, components, and file examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100