Description

The infrastructure to create amazing documentation.

Mission

Empower maintainers to create outstanding documentation for the developers.

Scope

The documentation infrastructure that powers all products (Material UI, Base UI, Pigment CSS, MUI X, and Toolpad) docs to exist effectively. We’re also considering extending it outside of just that:

• MUI Store: it could be an option to use it. However, there are also options like https://www.gitbook.com/, https://readme.com/.
• MUI Design kits: it could be an option to use it. However, there are also options like the Zendesk guide.

Responsibilities

The main responsibilities:

• UX/UI. Work with a designer to make sure the docs browsing experience is great.
• SEO. Make sure the content structure is optimized.
• i18n. Maintain the translation infrastructure. Make sure we sync with Crowdin efficiently.
• Search. Make sure the Algolia search integration performs really well.
• Dependencies. Keep them up-to-date, e.g., Next.js.
• demo. Ensure the demo experience is outstanding, e.g., live-edit, export to Stackblitz, etc.
• API. Ensure we have all the infrastructure necessary to document the components and the TypeScript modules.
• Performance. Make sure the overall docs platform loads fast and is snappy. Lighthouse or tracking the bundle size are good ways to monitor this.
• a11y. Make sure there are no accessibility errors in the backbone of the docs. Fix any errors the maintainers can't fix on the markdown or the demos. Use Lighthouse and WAVE to find them.
• Analytics. Make sure Google Analytics is well structured and that we can collect users' feedback on each page through features such as 👍/👎 buttons.