moodle / moodle/devdocs

[chore] Create a React component and/or mdx syntax to link to phpdocs

Open
#1,012 0 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?

Example:

<doclink language="php" class="\core\router\route">new route()</doclink>
<doclink language="php" class="\core\param" method="validate">param::INT->validate($content)</doclink>

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

The issue provides only JSX examples and names no files or tests. Start by locating the repository's React and MDX documentation-rendering entry points, then determine how the examples should resolve PHP classes and methods. Done means the documented syntax renders working links to the corresponding phpdocs.

Written by the indexing model from the issue text.

Assessment

Tech stack
php, react
Domain
documentation, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.