search

codama-idl / codama

Generate clients, CLIs, documentation and more from your Solana programs
MIT License
73 stars 16 forks source link

Add overview documentation #90

Closed lorisleiva closed 3 months ago

lorisleiva commented 3 months ago

Click here to preview markdown.

changeset-bot[bot] commented 3 months ago

⚠️ No Changeset found

Latest commit: 4774acd15374bc825e88721932f540e10dd8b082

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

febo commented 3 months ago

Looks very good! The only thing that I would suggest is to maybe reduce the size of the images, they seems a bit big for the amount of text and some sections don't have much text relatively to the size of the image (e.g., section "Nodes and visitors").

lorisleiva commented 3 months ago

Thanks Febo, I've adjusted the vertical padding of the diagrams. Just keep in mind that the README on the repo's homepage will have a much smaller width so they won't be expanded quite as much.