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

docs: Improve "data dictionary" section #291

Closed
scarmuega opened this issue May 9, 2022 · 2 comments
Closed

docs: Improve "data dictionary" section #291

scarmuega opened this issue May 9, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@scarmuega
Copy link
Member

The data dictionary section of the documentation should provide more detail about each event.

Ideally, we should have a title for each event with the following content:

  • A short description of what it represents (one-liner)
  • A short description of how it is obtained from the block data (1 or 2 paragraphs)
  • A table with a row for each field of the payload (columns for name, data type and description)
@scarmuega scarmuega added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 9, 2022
@ch1n3du
Copy link
Contributor

ch1n3du commented May 11, 2022

I wanted to clarify what you meant by the description of how the events are obtained from the block data. And on the third point I wanted to ask if the table should include the fields of the EventContext struct that are part of the current documentation, as the page seems to focus on the EventData enum

@scarmuega scarmuega mentioned this issue May 17, 2022
@scarmuega
Copy link
Member Author

very nice job, great 1st issue!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants