Skip to content
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

Closed
Savio-Sou opened this issue Apr 29, 2024 · 5 comments · Fixed by #5367
Closed

Align experimental feature disclaimers in docs #4935

Savio-Sou opened this issue Apr 29, 2024 · 5 comments · Fixed by #5367
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@Savio-Sou
Copy link
Collaborator

Savio-Sou commented Apr 29, 2024

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:

@Savio-Sou Savio-Sou added enhancement New feature or request documentation Improvements or additions to documentation labels Apr 29, 2024
@Savio-Sou Savio-Sou added this to Noir Apr 29, 2024
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Noir Apr 29, 2024
@Savio-Sou Savio-Sou added the good first issue Good for newcomers label Apr 29, 2024
@emmz3230
Copy link

emmz3230 commented Jun 3, 2024

ok will love to do it

@Savio-Sou
Copy link
Collaborator Author

🫡 Docusaurus's docs if it helps: https://docusaurus.io/docs/

PR welcome!

@emmz3230
Copy link

emmz3230 commented Jun 4, 2024

Yes, I even know how to use Docusaurus, so there won't be a problem with that.
What you want me to do is remove where their are two disclaimer modules, right?

@Savio-Sou
Copy link
Collaborator Author

There are currently admonitions on different pages in the docs that serve the same purpose: informing readers that the language feature is experimental.

For example:
image
image

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.

@emmz3230
Copy link

emmz3230 commented Jun 5, 2024

like a reusable component that will be imported in the doc page

github-merge-queue bot pushed a commit that referenced this issue Jul 16, 2024
…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.
@github-project-automation github-project-automation bot moved this from 📋 Backlog to ✅ Done in Noir Jul 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants