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

Streamline events related content #484

Open
tomerweller opened this issue Aug 3, 2023 · 1 comment
Open

Streamline events related content #484

tomerweller opened this issue Aug 3, 2023 · 1 comment
Assignees
Labels

Comments

@tomerweller
Copy link
Contributor

These are the following resources about events

  1. Events (Basic Tutorials): a guide on publishing events targeting contract developers
  2. Events (Fundamentals and Concepts): contains two parts. The first describes events under the txmeta hood, targeting a fairly advanced audience. The second is an explanation on diagnostic events without going to specifics.
  3. getEvents json-rpc reference

I suggest the following changes:

  1. Add a Consuming Events section at the end of the Events basic tutorial that demonstrated querying the RPC service for the events emitted in the tutorial.
  2. Kill the Events fundamentals and concepts section. Digging into the txmeta is not something that we do elsewhere in the docs and seems a bit more confusing than beneficial, especially since we expect people to consume events through the rpc's getEvents method
  3. Add a Diagnostic Events reference section that outlines all known diagnostic events
  4. Add a reference in the Debugging section on using diagnostic events and link to the reference from it
@janewang janewang transferred this issue from stellar-deprecated/soroban-docs Apr 16, 2024
@janewang janewang moved this from Backlog to To Do in Dev Docs Apr 25, 2024
@janewang janewang self-assigned this Apr 25, 2024
@janewang janewang removed their assignment Jan 10, 2025
@janewang janewang removed this from Dev Docs Jan 10, 2025
@janewang
Copy link
Contributor

May worth revisiting how events are described throughout our docs once we have unified events for classic and soroban

@mollykarcher mollykarcher moved this from Backlog to To Do in Platform Scrum Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: To Do
Development

No branches or pull requests

5 participants
@janewang @tomerweller @mollykarcher @briwylde08 and others