mui / mui/material-ui

[docs-infra] Allow {{"component": “}} to import from same markdown folder

Open
#41,127 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

scope: docs-infra type: enhancement
Dominant language
JavaScript
Stars
99.1k
Forks
32.5k
Avg merge
2d 17h
Merged PRs (30d)
106

Description

Summary

Having to the component source outside of the markdown folder like in https://github.com/mui/material-ui/blob/master/docs/data/material/all-components/all-components.md is not great. You want to be able to delete a page of the docs and all its related content all at once (closer folders).

Examples

No response

Motivation

No response

Search keywords: -

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 reading docs/data/material/all-components/all-components.md and tracing how its component source is imported by the documentation infrastructure. Identify the existing import-resolution entry point and verify how a component stored in the same markdown folder should be discovered. Done means the same-folder arrangement builds successfully while preserving the existing documentation output.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, markdown, react
Domain
documentation, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.