mui / mui/material-ui

[docs-infra] Scoped notification per product

Open
#41,664 3 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

Today, having a unified notification system doesn't make sense from a user perspective. For instance, it doesn't make sense to hear about a new MUI X version when browsing Pigment CSS. It doesn't make sense for a user to hear about Toolpad new version when browsing Base UI.

Examples

No response

Motivation

I would like us to not teach developers that the notifications on the docs are noise that should be ignored.

Solution

It could be as simple as having an array of products where the notification triggers in docs/notifications.json.

diff --git a/docs/notifications.json b/docs/notifications.json
index 4b3431c0..95b6916d 100644
--- a/docs/notifications.json
+++ b/docs/notifications.json
@@ -16,6 +16,7 @@
   },
   {
     "id": 80,
+    "productIds": ["x", "material-ui", "toolpad-core"],
     "title": "<b>MUI X v7.0.0-beta.0</b>",
     "text": "Featuring new components and multiple enhancements for both developers and end-users. Discover all the specifics in the <a style=\"color: inherit;\" data-ga-event-category=\"Announcement\" data-ga-event-action=\"notification\" data-ga-event-label=\"mui-x-v7-beta\" href=\"https://mui.com/blog/mui-x-v7-beta/\">announcement blog post</a>."
   }

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 with docs/notifications.json and inspect the documentation notification entry structure and the code that renders those entries for each product. Confirm how product context is represented, then scope each notification to its intended products and verify that unrelated product pages no longer display it.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
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.