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

Document solidity contracts #169

Open
gjermundgaraba opened this issue Dec 10, 2024 · 2 comments
Open

Document solidity contracts #169

gjermundgaraba opened this issue Dec 10, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@gjermundgaraba
Copy link
Contributor

Move any top level documentation about the solidity contracts to contracts/README.md and link to them from the root readme file.

It should be easy for someone who doesn't know the setup to go in and get a good overview over how the system works and how the different contracts interact.

Make sure the new README has at least the following:

  • Purpose and intended use case
  • High level architectural diagram with Mermaid
    • The main contracts should be outlined and made clear how they work together
  • How to build and test
  • How to integrate/use
@gjermundgaraba gjermundgaraba added the documentation Improvements or additions to documentation label Dec 10, 2024
@HMSagar2701
Copy link

Hi @gjermundgaraba , Can I work on this issue ?

@gjermundgaraba
Copy link
Contributor Author

Hi @HMSagar2701, thanks for the interest, but I was thinking maybe the team should take this one on as it requires quite deep understanding of all the components. If you anyway feel like you would be able to deep dive into how it works and do this, I will not stop you from making a PR which I will happily review :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Backlog
Development

No branches or pull requests

2 participants