moodle / moodle/devdocs

[docs] Update Navigation API docs with Secondary navigation info

Open
#948 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?

Navigation API needs to be reviewed and updated to use the terminology of Primary and Secondary navigation and contain information how to work with secondary navigation. Some content from from 4.0 Developer Update document can be reused for this.

Is this documentation specific to a Moodle version?

Yes

Are you able to provide a patch for this?

None

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 with the Navigation API documentation page and compare its terminology with the 4.0 Developer Update navigation changes document. Update the page to use Primary and Secondary navigation terminology and explain how to work with secondary navigation; done means the version-specific information is covered.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.