starknet-io / starknet-docs

The repo for Starknet's developer documentation. Includes contribution guidelines and the Starknet documentation supplementary style guide

https://docs.starknet.io/

112 stars 158 forks source link

feat: Starknet messaging function and event reference (based on #1094) #1209

Closed stoobie closed 1 week ago

stoobie commented 3 months ago

Description of the Changes

Add Messaging function and event reference.

Based on #1094.

Closes #1086.

PR Preview URL

Messaging reference

Check List

[x] Changes have been done against main branch, and PR does not conflict
[x] PR title follows the convention: <docs/feat/fix/chore>(optional scope): <description>, e.g: fix: minor typos in code

This change is

github-actions[bot] commented 3 months ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

stoobie commented 3 months ago

@xiaolou86 Please make sure you also implement Lucas' comment in #1094.

xiaolou86 commented 3 months ago

@xiaolou86 Please make sure you also implement Lucas' comment in #1094.

ok, I will update it.

stoobie commented 2 months ago

Hi @xiaolou86 Any update on this?

xiaolou86 commented 2 months ago

Hi @xiaolou86 Any update on this?

@stoobie I had already updated into #1094 2 weeks ago.

xiaolou86 commented 2 months ago

I am sorry that I don't know how to cherry-pick from #1094 to here.

github-actions[bot] commented 2 months ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

github-actions[bot] commented 2 months ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 2 months ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 2 months ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 2 months ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 2 months ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 1 month ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 1 month ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 1 month ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 1 month ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 1 month ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 1 month ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 1 month ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 1 month ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 1 month ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 1 month ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 1 month ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 1 month ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 1 month ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 1 month ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 1 month ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 1 month ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 1 month ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 1 month ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 1 month ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

starknet-bot commented 4 weeks ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/documentation/ .

stoobie commented 3 weeks ago

@xiaolou86 Please do the following:

Rename the file to be messaging-reference.adoc (hyphen replaces underscore in file name)
Copy the changes over from #1209.
For each event that is emitted, state which function emits it. For each function that emits an event, add a heading "Emitted event" with the name of the event that emitted it, with a link to the event lower down in the page. For example, see ConsumedMessageToL2 and consumeMessageFromL2 in #1209.

starknet-bot commented 3 weeks ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/ .

xiaolou86 commented 3 weeks ago

@xiaolou86 Please do the following:

Rename the file to be messaging-reference.adoc (hyphen replaces underscore in file name)

Copy the changes over from feat: Starknet messaging function and event reference (based on #1094) #1209.

For each event that is emitted, state which function emits it. For each function that emits an event, add a heading "Emitted event" with the name of the event that emitted it, with a link to the event lower down in the page. For example, see ConsumedMessageToL2 and consumeMessageFromL2 in feat: Starknet messaging function and event reference (based on #1094) #1209.

@stoobie All done in PR #1094 . Thank you very much.

starknet-bot commented 1 week ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/ .

starknet-bot commented 1 week ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1209/ .

stoobie commented 1 week ago

1094 is merged, so closing this one.