The README is the first form of documentation users stumble upon when visiting the repository. It should give users an overall understanding of the project, and steps to build and run the code in their local environment.
In our README, however, we've found several inconsistencies with the current state of the project. Here is a non-exhaustive list:
Explain how to generate Merkle proofs for output validation tests in the on-chain part
Prefer "on-chain" over "onchain", and "off-chain" over "offchain"
Link files in the repository with relative paths instead of URLs
Better explain how the DApp address relay works
We don't use state-server in tests anymore, because we've moved from Hardhat (Typescript) to Forge (Solidity)
Add links to documentation of Yarn and Forge for installation steps, like it is done for Cargo
✔️ Solution
We should fix these inconsistencies before the next release.
📚 Context
The README is the first form of documentation users stumble upon when visiting the repository. It should give users an overall understanding of the project, and steps to build and run the code in their local environment.
In our README, however, we've found several inconsistencies with the current state of the project. Here is a non-exhaustive list:
state-serverin tests anymore, because we've moved from Hardhat (Typescript) to Forge (Solidity)✔️ Solution
We should fix these inconsistencies before the next release.