mui / mui/material-ui

[docs] No more links to component implementations in documentation

Open
#29,834 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

scope: all components type: new feature
Dominant language
JavaScript
Stars
99.1k
Forks
32.5k
Avg merge
2d 17h
Merged PRs (30d)
106

Description

Duplicates
  • I have searched the existing issues
Latest version
  • I have tested the latest version
Summary 💡

In the past, the documentation would have links to the component implementation.
This was really helpful to dig into the code a bit more, especially when designing component style overrides, as the source code is really helpful for this.

I would like to propose reintroducing these links again throughout the documentation and perhaps even having them in a unified location within the docs.

While I understand, that the implementation should not matter for a library to be used, there are often situations where it is still extremely helpful - especially in the cases of style overrides.

The current alternative of always navigating through the source tree on github works as well of course, but is cumbersome and I really miss the simplicity of the links in the past.

Examples 🌈

No response

Motivation 🔦

As described above:

  • Simplify looking up the implementation for some components to understand inner workings which are not (or only in rare cases) documented
  • Simplify creating style overrides by having easy access to the base implementation

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

No specific files, tests, or documentation entry points are named. Start by reviewing the current component documentation and source tree to determine how implementation links could be organized; the work is done when the chosen link approach is defined and applied consistently throughout the relevant documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation
Issue type
Documentation
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.