Evaluate MACI documentation needs

[samajammin]

Evaluate MACI documentation needs

[yuetloo]

I would like to see more details on MACI integration.

• Circuit parameters
  For example, if we use circuit micro, what version of MACI works with this circuit and if there's trusted setup.
  What parameters to pass to the setVerifyingKeys and the deployPoll cli to use the (e.g. micro) circuit.

• How to verify tally results on chain
  The verify cli only verifies tally results off-chain.

• Complete integration flow
  Currently, the integration guide only talks about contributing and publishing messages. Would like to see a more complete flow starting from deploying contracts, integrating with InitialVoiceCreditProxy, using the topup feature and the subsidy feature, finalizing, verifying on-chain, how to check in the contract if a poll was finalized.

• Cancel or reset poll
  In v0.10.1, there's coordinatorReset function to reset and redo the tally if tallying failed, (e.g., incorrect MACI logs being passed to the tally script). In v1, since there's no reset function, does it mean there's no option to cancel or reset a poll?

[ctrlc03]

Completed #826

[samajammin]

Added Docusaurus as an option:
https://docusaurus.io/

They JUST released v3.0, which looks to have all the features we'd need:
https://docusaurus.io/blog/releases/3.0

I see Semaphore uses it as well:
https://github.com/semaphore-protocol/website
Might be nice to share resources/learnings on that front...

[a2468834]

Hello @samajammin 👋
I have the same feeling you told in #728.
Recently, I am starting to work on simplifying the docs first.
But I don't have any concrete roadmap or task list yet.

Besides, after chatting with one of contributor previously, I think we could use some LLM tools for evaluate the quality of docs (e.g, LLM-Adapters).

It's quite nice to hear other developer talking about the same issue.
Maybe we could discuss more and share the tasks in this issue together.

[samajammin]

Without having done much in-depth research across options, I like the look of Docusaurus:

• It supports all the requirements & nice-to-haves listed in the issue
• It appears to be well-maintained by Meta & they just released a fresh new version
• It seems highly customizable, e.g. to build one-off pages or a blog, so it seems we could easily extend this from purely dev documentation to a fully-fledged website as we have the time/resources to do that - I don't believe any other options I listed support that functionality
• It's used by other PSE teams (e.g. Semaphore & Unirep), so could be nice to share resources/learnings on that front

I don't think this is something we need to sink much time into in terms of evaluating options, so I'd suggest we just role with that if @ctrlc03 @baumstern you folks don't have any questions/concerns. If you have a preference for another solution, please share!