-
Notifications
You must be signed in to change notification settings - Fork 199
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Align experimental feature disclaimers in docs #4935
Comments
ok will love to do it |
🫡 Docusaurus's docs if it helps: https://docusaurus.io/docs/ PR welcome! |
Yes, I even know how to use Docusaurus, so there won't be a problem with that. |
There are currently admonitions on different pages in the docs that serve the same purpose: informing readers that the language feature is experimental. It would be good to create a module for such an admonition, then simply link to it on the doc pages necessary (instead of each page having its own different admonition). Supplemented additional context in the Issue body. |
like a reusable component that will be imported in the doc page |
…on (#5367) # Description ## Problem\* Resolves #4935 ## Summary\* This pull request makes the experimental feature warnings the same across different parts of the documentation. I've created one warning message that all pages can show. This helps in keeping the docs consistent and easy to update. ## Additional Context The new disclaimer meets all the requirements set out in issue #4935 by: - Clearly stating that the feature is experimental; - Noting that the documentation may be incomplete or out of date, and thus subject to changes that could impact its behavior or functionality; - Encouraging contributions and providing a direct link to the project's GitHub repository. ## Documentation\* Check one: - [ ] No documentation needed. - [x] Documentation included in this PR. - [ ] **[For Experimental Features]** Documentation to be submitted in a separate PR. # PR Checklist\* - [x] I have tested the changes locally. - [ ] I have formatted the changes with [Prettier](https://prettier.io/) and/or `cargo fmt` on default settings.
Problem
We currently have different versions of experimental feature disclaimers in our docs:
Happy case
We should create one disclaimer module, then update the pages to link to it instead.
The disclaimer should specify:
The text was updated successfully, but these errors were encountered: