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

Edit or remove the warning message of docusaurus #1471

Closed
1 task
kittybest opened this issue May 16, 2024 · 6 comments · Fixed by #1797
Closed
1 task

Edit or remove the warning message of docusaurus #1471

kittybest opened this issue May 16, 2024 · 6 comments · Fixed by #1797
Assignees
Labels
good first issue Good for newcomers

Comments

@kittybest
Copy link
Collaborator

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

@ctrlc03
Copy link
Collaborator

ctrlc03 commented May 21, 2024

@ctrlc03 ctrlc03 added the good first issue Good for newcomers label Aug 9, 2024
@wildanvin
Copy link
Contributor

Hello,
I would like to work on this issue please

@ctrlc03
Copy link
Collaborator

ctrlc03 commented Aug 26, 2024

Hello, I would like to work on this issue please

Nice thank you very much. Have assigned you

@wildanvin
Copy link
Contributor

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

@ctrlc03
Copy link
Collaborator

ctrlc03 commented Aug 29, 2024

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 🙏

@wildanvin
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants