search

Agoric / documentation

User documentation
https://agoric.com/documentation/
Apache License 2.0
14 stars 38 forks source link

Revamping contract basics docs by splitting contracts and enhancing readability #1104

Closed ghost closed 3 weeks ago

ghost commented 1 month ago

I am using this PR to add structure to contract basics docs. Essentially, I am splitting the three smart contracts discussed there to their separate pages. I also added some introductory text to the original contract basics page and added text to the remaining pages for improved readability.

cloudflare-pages[bot] commented 1 month ago

Deploying documentation with  Cloudflare Pages  Cloudflare Pages

Latest commit: ca32303
Status: ✅  Deploy successful!
Preview URL: https://ad8761f1.documentation-7tp.pages.dev
Branch Preview URL: https://ms-update-state-contract.documentation-7tp.pages.dev

View logs

github-actions[bot] commented 1 month ago

Cloudflare deployment logs are available here

samsiegart commented 4 weeks ago

Not sure if in scope for this PR (and no issue linked so not sure what else is planned), but would be great to see an example that uses vstorage, Maybe worth clarifying in contract-state.md that vstorage is required to read the state from off-chain.

ghost commented 4 weeks ago

Not sure if in scope for this PR (and no issue linked so not sure what else is planned), but would be great to see an example that uses vstorage, Maybe worth clarifying in contract-state.md that vstorage is required to read the state from off-chain.

@samsiegart Great idea. @ansabgillani recently wrote a docs page for VStorage. We should probably request him to generate a separate PR with an example in contract-state.md.