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

Add "Beta" or "Experimental" tag in documentation, for topics like keccak+ECDSA #450

Closed
barriebyron opened this issue Jun 27, 2023 · 9 comments · Fixed by #581
Closed

Add "Beta" or "Experimental" tag in documentation, for topics like keccak+ECDSA #450

barriebyron opened this issue Jun 27, 2023 · 9 comments · Fixed by #581
Labels
docs Improvements or additions to documentation

Comments

@barriebyron
Copy link
Contributor

barriebyron commented Jun 27, 2023

From @stevenpack

The crypto team doesn't characterize ECDSA+keccak as "production hardened" yet, but we want to get into the hands of our users to get usability and performance feedback. We should make this clear in the docs. If we don't already have it, please introduce the concept of tagging a feature as "beta" and start with ECDSA. (or if we already have an existing lifecycle type of annotation, please use that).

See the original issue with comment threads

o1-labs/zkapp-cli#440 (comment) was inadvertently created in a different repository

@barriebyron
Copy link
Contributor Author

@stevenpack wdyt about using Experimental instead of Beta?

I am familiar with this hierarchy of feature labels that set expectations with our users:

  1. Experimental
  2. Beta
  3. GA (what we call production hardened)

https://handbook.sourcegraph.com/departments/engineering/product/process/gtm/beta_and_experimental_feature_labels/

I like the idea of having a docs topic similar to
https://docs.sourcegraph.com/admin/beta_and_experimental_features
with guidance to ask questions and provide feedback in Discord

@barriebyron
Copy link
Contributor Author

use the info box explaining experimental

@barriebyron
Copy link
Contributor Author

barriebyron commented Aug 15, 2023

see proposed new topic #563

@barriebyron barriebyron added the docs Improvements or additions to documentation label Aug 15, 2023
@garwalsh
Copy link
Contributor

@barriebyron Can we implement the tag as an info box or callout as you suggested above?
image

@barriebyron
Copy link
Contributor Author

@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

@barriebyron
Copy link
Contributor Author

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:

If we wanted to customise this behavior, it's very quick to do. I'd estimate this to be pretty fast to do, no more than a 2 for our sprint planning. It's even easier if we just use one of the shipped ones!

@MartinMinkov
Copy link
Contributor

#563 is merged, is this issue okay to close? @barriebyron

@barriebyron
Copy link
Contributor Author

@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?
thanks for helping me keeping this enhancement request straight and alive

@MartinMinkov
Copy link
Contributor

Will follow up with a admonition enhancement to our front end!

@barriebyron barriebyron changed the title Add "Beta" or "Experimental" tag in documentation for keccak+ECDSA Add "Beta" or "Experimental" tag in documentation, for topics like keccak+ECDSA Sep 5, 2023
@MartinMinkov MartinMinkov linked a pull request Sep 6, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants