maci icon indicating copy to clipboard operation
maci copied to clipboard

Edit or remove the warning message of docusaurus

Open kittybest opened this issue 1 year ago • 1 comments
trafficstars

Prerequisites

Please answer the following question for yourself before submitting a feature request.

  • [ ] I checked to make sure that this request has not already been filed

Motivation & Details

image

This message is kind of misleading, we actually are still updating the documents of v1.2, besides the latest version.


Make sure that you have reviewed MACI's Contributor Guidelines

kittybest avatar May 16 '24 15:05 kittybest

I found this: https://github.com/facebook/docusaurus/blob/525b0c2b5b55cc965de92ddeaac79d6fe6c62aea/packages/docusaurus-theme-classic/src/theme/DocVersionSuggestions/index.tsx#L53 but couldn't find a way to actually fully customize the message

ctrlc03 avatar May 21 '24 17:05 ctrlc03

Hello, I would like to work on this issue please

wildanvin avatar Aug 26 '24 21:08 wildanvin

Hello, I would like to work on this issue please

Nice thank you very much. Have assigned you

ctrlc03 avatar Aug 26 '24 21:08 ctrlc03

Hello,

I was doing some research and found that Docusaurus only has the options of none, unreleased and unmaintained for the versioning banner. So it is not possible to add a custom banner.

What I did was to remove the banner entirely and just add an info message in the introduction.md and circuits.md (where I think the info message is more relevant)

The message that I am thinking is: "Version 1.2.4 of MACI's circuits has been audited and includes zKeys that have completed a trusted setup. v2 will also undergo this process soon".

This is what it looks like with said changes:

image

image

Please let me know what do you think

wildanvin avatar Aug 29 '24 06:08 wildanvin

The message that I am thinking is: "Version 1.2.4 of MACI's circuits has been audited and includes zKeys that have completed a trusted setup. v2 will also undergo this process soon".

This is what it looks like with said changes:

Nice!! I think we can go ahead with this, but maybe instead of this message it could be something along the lines of: "For a more secure and stable protocol, please refer to MACI v2.x" - and have this on the introduction page

Thanks so much for this 🙏

ctrlc03 avatar Aug 29 '24 07:08 ctrlc03

Great! I will change the message and submit the PR a bit later today

wildanvin avatar Aug 29 '24 22:08 wildanvin