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

Docs(coordinator): update instruction of the coordinator #445

Open
kittybest opened this issue Nov 7, 2024 · 1 comment
Open

Docs(coordinator): update instruction of the coordinator #445

kittybest opened this issue Nov 7, 2024 · 1 comment

Comments

@kittybest
Copy link
Collaborator

Description
I'm not sure where to provide instructions on how to use the entire repository, but theoretically, the process should look like this:

  1. install and build
  2. especially need to run build command inside the contracts package
  3. run download-zkeys command either in the root or the coordinator package
  4. update the deploy-config.json file inside the contracts package
  5. deploy basic maci contracts inside the contracts package
  6. go to coordinator package, set up the round-metadata.json file and run the upload-round-metadata command
  7. go to subgraph package, set up the network.json file and run the commands inside the README.md file
  8. update the deploy-config.json again, then deploy-poll inside the contracts package

How do you think where should we update these instructions?

@aguzmant103
Copy link
Member

@kittybest @crisgarner where are you putting this type of documentation?

I tend to like:

  • A repo with basic commands to get it up and running with default specs (and see the UI)
  • An in-depth documentation elsewhere where I can configure all the details (hopefully in the future from the GUI or in "1 click")

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

2 participants