chore: review contract conventions section #2229
Conversation
There was a problem hiding this comment.
Pull request overview
This PR reviews and updates the contract conventions documentation section, with a focus on correcting technical inaccuracies and improving clarity. The changes include bug fixes (correcting variable names and event topic descriptions), documentation improvements (better explanations of error handling and TTL extension), and code example updates to reflect current best practices.
Changes:
- Fixed typos and variable naming errors across multiple documentation files
- Significantly expanded and restructured the TTL extension guide to better explain contract instance vs code entries
- Enhanced error handling documentation with clearer examples of
panic_with_error!vsResultpatterns - Updated import patterns and improved consistency in JavaScript SDK examples
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/learn/fundamentals/stellar-data-structures/events.mdx | Fixed system event topics to correctly show new_executable instead of duplicate old_executable |
| docs/build/guides/conventions/workspace.mdx | Updated contract client naming from generic ContractAClient/ContractAInterface to more descriptive AdderClient/Adder |
| docs/build/guides/conventions/upgrading-contracts.mdx | Fixed variable name typo (e to env) and corrected event topics description |
| docs/build/guides/conventions/extending-wasm-ttl.mdx | Major restructuring: clarified contract instance vs code TTL, added CLI examples, improved JS SDK usage with proper simulation |
| docs/build/guides/conventions/error-enum.mdx | Expanded documentation to explain both panic_with_error! and Result error handling patterns with clear examples |
| docs/build/guides/conventions/deploy-sac-with-code.mdx | Updated SDK imports to use StellarSdk.rpc.Server, improved variable naming consistency, removed duplicate declarations |
| docs/build/guides/conventions/deploy-contract.mdx | Updated example repository version from v20.2.0 to v22.0.1, corrected path from deployer/contracts to deployer/contract |
| docs/build/guides/conventions/cross-contract.mdx | Grammar and clarity improvements throughout, better explanation of contract client vs manual invocation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
Preview is available here: |
4 similar comments
|
Preview is available here: |
|
Preview is available here: |
|
Preview is available here: |
|
Preview is available here: |
2 participants
Review and make minor adjustments to contract conventions docs.
Larger edits for the following pages:
/docs/build/guides/conventions/extending-wasm-ttl/docs/build/guides/conventions/error-enum