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

feat(docs): emit/event docs #2047

Merged
merged 14 commits into from
May 13, 2024
Merged

feat(docs): emit/event docs #2047

merged 14 commits into from
May 13, 2024

Conversation

leohhhn
Copy link
Contributor

@leohhhn leohhhn commented May 6, 2024

Description

This PR adds docs for emit/event. It adds reference docs, and a section in effective Gno. More practical examples will be added to Gno By Example.

Closes: #2003

Contributors' checklist...
  • Added new tests, or not needed, or not feasible
  • Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
  • Updated the official documentation or not needed
  • No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
  • Added references to related issues and PRs
  • Provided any useful hints for running manual tests
  • Added new benchmarks to generated graphs, if any. More info here.

@leohhhn leohhhn requested a review from moul as a code owner May 6, 2024 19:34
Copy link
Member

@zivkovicmilos zivkovicmilos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find it strange that you didn't mention the required PR on the docs repo anywhere:
gnolang/docs.gno.land#29

Please fix the failing PR on that repo, it can't even build because of invalid IDs.
We can see what to do about this one after that

Also, please add adequate labels to this PR 🙏

@zivkovicmilos zivkovicmilos marked this pull request as draft May 8, 2024 11:20
@leohhhn
Copy link
Contributor Author

leohhhn commented May 9, 2024

Hey @zivkovicmilos,

I find it strange that you didn't mention the required PR on the docs repo anywhere:

I've linked this PR in the docs.gno.land repo PR, so the connection should be visible (right above your comment).

Please fix the failing PR on that repo, it can't even build because of invalid IDs.

Due to the setup that we currently have with the documentation infra, it is currently not possible to build or preview the documentation on the docs.gno.land repo - which is why the CI is red on the mentioned PR. Specifically, this is because the CI on the other repo fetches the monorepo master branch and tries to build the files, but since this PR here has not been merged yet (and thus the files are missing, hence the 'invalid ID' error), the build will fail.

Currently, the only way to get the CI fixed on the other repo is to merge content here first. This PR is ready for review - please convert it back to the correct status 🙏

Also, please add adequate labels to this PR 🙏

Added the docs label - I was under the impression that we have a bot doing that for us.

@leohhhn leohhhn added the 📖 documentation Improvements or additions to documentation label May 9, 2024
@leohhhn leohhhn requested a review from notJoon May 9, 2024 18:56
Copy link
Member

@notJoon notJoon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left some minor things, but overall it's well written. 👍

@leohhhn leohhhn marked this pull request as ready for review May 10, 2024 10:43
docs/concepts/effective-gno.md Outdated Show resolved Hide resolved
@leohhhn leohhhn merged commit 977a3f4 into gnolang:master May 13, 2024
6 checks passed
@leohhhn leohhhn deleted the docs/events branch May 13, 2024 14:16
DIGIX666 pushed a commit to kazai777/gno that referenced this pull request May 15, 2024
<!-- please provide a detailed description of the changes made in this
pull request. -->

## Description

This PR adds docs for emit/event. It adds reference docs, and a section
in effective Gno. More practical examples will be added to Gno By
Example.

Closes: gnolang#2003 

<details><summary>Contributors' checklist...</summary>

- [ ] Added new tests, or not needed, or not feasible
- [ ] Provided an example (e.g. screenshot) to aid review or the PR is
self-explanatory
- [ ] Updated the official documentation or not needed
- [ ] No breaking changes were made, or a `BREAKING CHANGE: xxx` message
was included in the description
- [ ] Added references to related issues and PRs
- [ ] Provided any useful hints for running manual tests
- [ ] Added new benchmarks to [generated
graphs](https://gnoland.github.io/benchmarks), if any. More info
[here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md).
</details>

---------

Co-authored-by: Lee ByeongJun <[email protected]>
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
Projects
Status: Done
Status: Done
Status: Done
Development

Successfully merging this pull request may close these issues.

[docs] Add documentation for Event / Emit
3 participants