-
Notifications
You must be signed in to change notification settings - Fork 136
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
Add "Beta" or "Experimental" tag in documentation, for topics like keccak+ECDSA #450
Comments
@stevenpack wdyt about using Experimental instead of Beta? I am familiar with this hierarchy of feature labels that set expectations with our users:
I like the idea of having a docs topic similar to |
use the info box explaining experimental |
see proposed new topic #563 |
@barriebyron Can we implement the tag as an info box or callout as you suggested above? |
@MartinMinkov will know what our options are for implementing an experimental callout in docs. In Docusaurus, the callout is called an admonition https://docusaurus.io/docs/markdown-features/admonitions The Markdown syntax for the built-in preset-classic callouts is documented in our docs style guide https://github.com/o1-labs/docs2/wiki/Markdown-Syntax#callouts Martin, could we customize admonitions to add an Experimental type? per https://docusaurus.io/docs/markdown-features/admonitions#customizing-admonitions Also, could we change the green color in the TIP callout? to some other color like lavender to go along with MF theme |
https://github.com/o1-labs/docs2/pull/571/files for the requested text update and removing from sidebar (great idea from Maki so our readers don't arrive at the page w/o context) @MartinMinkov tells us:
|
#563 is merged, is this issue okay to close? @barriebyron |
@MartinMinkov we talked about admonition enhancement... is this the issue to track that work in? or did I lost track and we have another issue, or we need another issue? |
Will follow up with a admonition enhancement to our front end! |
From @stevenpack
See the original issue with comment threads
o1-labs/zkapp-cli#440 (comment) was inadvertently created in a different repository
The text was updated successfully, but these errors were encountered: