[docs-infra][RFC] Show a banner with a warning on deploy previews
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 99.1k
- Forks
- 32.5k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 106
Description
What's the problem? 🤔
Sometimes we share deploy previews with our users to showcase the feature before it's released or to demonstrate a bugfix.
Users might get confused and expect the feature to be released publicly, which is not the case (I think @joserodolfofreitas mentioned that we had support requests regarding this).
Or they might find an old deployment preview URL in the issues, but the API has changed since.
What are the requirements? ❓
No response
What are our options? 💡
No response
Proposed solution 🟢
To avoid these confusions, we might want to add a warning for all deployment previews, similar to what we have on https://v4.mui.com/ to make it clear that this is a preview and some features might not be publicly released yet
Relevant resources/benchmarks 🔗
No response
Search keywords:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue identifies deploy previews and references the warning on v4.mui.com, but names no repository files, tests, or entry points. Start by locating the deploy-preview documentation infrastructure and the existing banner implementation, then clarify the warning's scope, placement, and validation before defining done.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, infrastructure
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100