noir-lang / noir

Noir is a domain specific language for zero knowledge proofs
https://noir-lang.org
Apache License 2.0
821 stars 177 forks source link

Align experimental feature disclaimers in docs #4935

Open Savio-Sou opened 2 months ago

Savio-Sou commented 2 months ago

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:

emmz3230 commented 4 weeks ago

ok will love to do it

Savio-Sou commented 4 weeks ago

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

PR welcome!

emmz3230 commented 4 weeks ago

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 commented 4 weeks ago

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 commented 3 weeks ago

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