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

Reestructure README docs #107

Open
acuarica opened this issue Nov 5, 2024 · 0 comments
Open

Reestructure README docs #107

acuarica opened this issue Nov 5, 2024 · 0 comments
Assignees
Labels
docs Improvements or additions to documentation

Comments

@acuarica
Copy link
Contributor

acuarica commented Nov 5, 2024

The current README sitting at the project's root folder contains mostly design decisions and implementation details. This is quite useful for contributors to help them understand the project. However, this is not the case for consumers/users of the Hardhat plugin and Foundry library.

Include the appropriate documentation targeting final users in this README. This should include basic instructions on how to use both solutions, and any configuration necessary to make it work. The PR1 includes some documentation regarding the Foundry library.

One possible solution could be to structure the design docs as following2

  • docs/README.md - general approach that we've laid out mostly on the README in terms of intercepting calls, system contracts, HTS tokens that support ERCs, etc.
  • docs/storage.md - more details and structure to the storage methodology also laid out in the README.
  • docs/hardhat-forking.md - the specific Hardhat approach. The sequence diagram in the README belongs here.
  • docs/foundry-forking.md - the specific Foundry approach. Explain how we use the same base contract to reuse behavior and storage layout, but we provide the actual data from Mirror Node calls within the EVM1.

If splitting up this design docs becomes problematic due to how interleaved both solutions are, we could have a single DESIGN.md sitting at the root folder containing all of it.

Footnotes

  1. https://github.com/hashgraph/hedera-forking/pull/105 2

  2. Thanks @Nana-EC for the suggestion.

@acuarica acuarica added the docs Improvements or additions to documentation label Nov 5, 2024
@acuarica acuarica self-assigned this Nov 19, 2024
@acuarica acuarica moved this from Backlog to Tasks In Progress in Smart Contract Sprint Board Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
Status: Sprint Backlog
Development

No branches or pull requests

1 participant