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 Get Started to docs, similar to ethers.js style #33

Open
chrisli30 opened this issue Nov 22, 2024 · 0 comments
Open

Add Get Started to docs, similar to ethers.js style #33

chrisli30 opened this issue Nov 22, 2024 · 0 comments

Comments

@chrisli30
Copy link
Member

is this a simplify jsdoc ? TODO: we need to explore the jsdoc solution

i also like the approach of https://docs.ethers.org/v6/api/ where they had getting started to guide end-user through a how-to style, and the api docs look up when you know how to use it, you just need to look up api doc.

i think eventually we should incoporate that kind of style into our https://avaprotocol.org/docs/ethereum/develop/api-reference

Originally posted by @v9n in #32 (review)

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

1 participant