moodle / moodle/devdocs

[chore] Attempt to link straight to same doc in different version

Open
#477 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted repo
Dominant language
TypeScript
Stars
74
Forks
652
Avg merge
2d 50m
Merged PRs (30d)
12

Description

What do we need to do?

Regarding versioned documentation, a suggestion from Eloy:

If you hover the menu (or click on the "triangle") it correctly shows you the available options (master, 4.1 and legacy). Then can select any of them, all ok. But, if you click on the "name" of the current version, then you're redirected to the "base" document in that version. IMO, that's completely unexpected. The "name" should behave the very same than the "triangle" or become 100% disabled.

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 locating the versioned documentation navigation described in the issue and compare what happens when selecting the current version name with selecting its triangle. Done means the name behaves like the triangle or is completely disabled, while links to the available versions still work.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
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.