fcl-js
fcl-js copied to clipboard
Docs: Add Event Name Format to FCL Docs
Issue
There is no explanation on the FCL events docs for how to derive the event name to put inside of fcl.events(). Someone has to find the format on another non-FCL page.
Suggestion
Either one of the following would work:
- Add documentation on this page for how to derive an event name like they do on this CLI page
- Link to another page that explains it
Hi @chasefleming @JeffreyDoyle , Can I work on this issue please?
@felixjordandev that would be great! Can just be something simple. Even just a line. Thanks.
Hi @chasefleming , Thanks for assigning me on this issue. I've done some progress on my end already. I've created documentation that explains the event name format for FCL events, covering both core events (flow.<event name>) and smart contract events (A.<contract address>.<contract name>.<event name>).
I noticed that the FCL API documentation has been moved to https://github.com/onflow/docs. Should I:
- Submit a PR directly to the onflow/docs repository with these changes?
- Or is it sufficient to submit the PR here with the documentation, and you'll handle moving it to the right place?
Thanks for the guidance!