-
Notifications
You must be signed in to change notification settings - Fork 82
Some changes to the events example page #101
Conversation
Something went wrong with PR preview build please check |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jayz22 I'm making some suggested changes to the events example copy/text. If you're okay with them please merge.
docs/examples/events.mdx
Outdated
Contract events are introduced in "[CAP-56: Smart Contract Events]", which lets smart contract developers to | ||
emit information about what their contract is doing. | ||
[CAP-56: Smart Contract Events]: https://github.com/stellar/stellar-protocol/blob/master/core/cap-0056.md | ||
Contract events let smart contract developers emit information about what their |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suggest we leave links to the CAPs out of the examples. People digging into the examples probably aren't at the point where they're going deep on CAPs, but rather exploring and learning.
docs/examples/events.mdx
Outdated
[host environment]: http://localhost:3000/docs/learn/high-level-overview#host-environment | ||
[host environment]: ../../learn/high-level-overview#host-environment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Links need to be relative paths.
Something went wrong with PR preview build please check |
Preview is available here: |
Preview is available here: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @leighmcculloch for making the changes. This looks much better than what I had. Please feel free to merge it.
* noop * noop * Update sdk and cli versions and output (#87) * Update code samples in quickstart (#88) * empty * Update the tutorial for creating a project (#89) * Update the tutorial for writing a contract (#90) * Update the tutorial for testing (#91) * Update the hello_world contract (#92) * Small fix to hello contract * Update the increment contract (#93) * Small fix to increment example * Update the custom_types contract (#94) * Add auth example and update auth learn page (#95) * Put auth example earlier in list of examples (#98) (cherry picked from commit fc2fc75) * Add events example (#100) * Update the cross_contract contract (#99) * Small tweak to contract call doc * Fix to contract call code sample * Fix to contract call code sample * noop to try and make it deploy properly * Reorder examples so that contract events appears higher in list * Fix headings of cross contract example (#102) * Add soroban-cli read example * Tweak language about developer discord * Some changes to the events example page (#101) * Rename standard-contracts and update token-contract (#103) * Rename Standard Contracts to Built-In Contracts * Update built-in-contracts/token-contract and examples/authorization * Fix title capitalization of built-in contracts page (#104) * Add stub for token example (#105) * Update authorization docs to line up with contract examples (#106) * Small fixes for token contract doc * Make authorization docs line up with the example * Instruct users to checkout v0.0.4 tag for examples (#107) * fix pages and sdk instructions * Add auth sdk page Co-authored-by: Tyler van der Hoeven <hi@tyvdh.com> Co-authored-by: Siddharth Suresh <siddharth@stellar.org> Co-authored-by: Jay Geng <junzhe.g@gmail.com> Co-authored-by: jonjove <31668823+jonjove@users.noreply.github.com>
What
Some changes to the events example page
Why