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

Add documentation website to improve discoverability #20

Open
aviggiano opened this issue Nov 16, 2024 · 3 comments
Open

Add documentation website to improve discoverability #20

aviggiano opened this issue Nov 16, 2024 · 3 comments

Comments

@aviggiano
Copy link

It would be nice to see what's in here just from reading the README

@ernestognw
Copy link
Member

Hey @aviggiano, I put out a CHANGELOG so you can start taking a look.

I was thinking we can have the contracts tree in the README but might be too difficult to keep in sync

contracts
├── access
│   └── manager
│       └── AccessManagerLight.sol
├── proxy
│   └── HybridProxy.sol
├── token
│   ├── ERC20
│   │   └── extensions
│   │       ├── ERC20Allowlist.sol
│   │       ├── ERC20Blocklist.sol
│   │       ├── ERC20Collateral.sol
│   │       ├── ERC20Custodian.sol
│   │       └── ERC4626Fees.sol
│   └── OnTokenTransferAdapter.sol
└── utils
    ├── Masks.sol
    └── cryptography
        ├── draft-ERC7739Signer.sol
        └── draft-ERC7739Utils.sol

@aviggiano
Copy link
Author

aviggiano commented Nov 20, 2024

I agree that it is hard* to keep in sync, although very useful. Maybe a documentation website like the one from the original contracts repo would be nice some day.

@ernestognw
Copy link
Member

Good point. I think a documentation website is a good middle ground so I'll work on that over the following weeks.

I'm renaming the issue accordingly. Thanks for your feedback @aviggiano!

@ernestognw ernestognw changed the title Add list of contracts to README Add documentation website to improve discoverability Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants