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 specs page in the docs #336

Open
lumtis opened this issue Aug 19, 2024 · 2 comments
Open

Add specs page in the docs #336

lumtis opened this issue Aug 19, 2024 · 2 comments

Comments

@lumtis
Copy link
Member

lumtis commented Aug 19, 2024

Example: docs provided for audit

Add similar page as part of the docs so it can be rendered on the website.

We check to give a proper design for the two diagrams.

Preferably let's wait for the audit to complete first as the interface is subject to change.

@fadeev
Copy link
Member

fadeev commented Aug 21, 2024

zeta-chain/docs#433

@fadeev
Copy link
Member

fadeev commented Aug 21, 2024

I think we can have just two docs: inline docs in the contracts (automatically converted into MD files by forge doc and shipped to the docs repo) and manually written docs in the docs repo (PR above is a draft attempt at that).

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