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: Added email address to contact for adding a custom bridge to StarkGate. #923

Merged
merged 1 commit into from
Nov 7, 2023

Conversation

stoobie
Copy link
Collaborator

@stoobie stoobie commented Nov 7, 2023

Description of the Changes

Added email address to contact for adding a custom bridge to StarkGate.

PR Preview URL

After you push a commit to this PR, a preview is built and a URL to the root of the preview appears in the comment feed.

Paste here the specific URL(s) of the content that this PR addresses.

Check List

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

This change is Reviewable

Copy link

github-actions bot commented Nov 7, 2023

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

@stoobie stoobie merged commit c5f32c7 into starkgatev2.0 Nov 7, 2023
2 checks passed
@stoobie stoobie deleted the steve/starkgate2.0/email_address branch November 7, 2023 15:44
stoobie added a commit that referenced this pull request Dec 19, 2023
* docs: StarkGate function/event reference, architecture topic, procedural content. (#886)

* Adding a new topic with functions for StarkGate.

* Added blockToken

* Added deactivateToken

* Added more functions.

* Added getWithdrawalBridges.

* Renamed token-bridge.adoc to starkgate-bridge.adoc. Added entries to .htaccess.

* Add L2 functions.

* Added params to addExistingBridge.

* SME comment

* Minor fixes.

* Added more functions.

* More edits.

* Add getStatus

* Add Cancelling a deposit.

* Added deposit and depositReclaim

* Add table-striping to description lists for parameters and returns.

* Adding types to parameters.

* Adding event to `Deposit`

* Add depositWithMessage

* Updates to overview.

* Adding `depositWithMessage*` functions.

* SME comments

* depositWithMessage* functions.

* Moved desc of Manager and Registry to top of section.

* SME comments

* SME comments

* SME comments

* Added new topic: StarkGate architecture.

* Changed name of file from stargate_dev_reference.adoc to starkgate_function_reference.adoc; Removed info on adding a custom bridge from starkgate-adding_a_token.adoc.

* Updated starkgate_architecture.adoc.

* SME comments, cleaning up scattered links.

* Edit xref text for deposit function and event

* Edited name of reference doc

* Fixed broken xref.

* Added list of functions in each contract.

* Updated architecture topic.

* Removed the section on the Manager and the Registry. I don't think that this is helpful.

* Added AsciiDoc role to function heading in prep for adding style to make heading clearer.

* Updates to Architecture topic based on SME engineering and product feedback.

* Updates to function reference based on SME comments.

* Fixed typo.

* Added Visibility header.

* Consistency edits.

* Consistency edits.

---------

Co-authored-by: JameStark <113911244+JameStark@users.noreply.github.com>

* Added email address to contact for adding a custom bridge to StarkGate. (#923)

* docs: Add `on_receive` function interface and note about backward compatibility (#933)

* Add `on_receive` function interface.

* Add snippet_backwards_compatibiity_note.adoc with a note about backwards compatibility. Put note in:
starkgate_architecture.adoc
starkgate_function_reference.adoc
starkgate-bridge.adoc

* Started to add tagged regions for event descriptions to use same text as parameter descriptions.

* SME comments.

* Adding tagged regions for event params.

* Adding tagged regions for event params.

* Added concept topic explaining the depositWithMessage flow.

* SME comment

* SME Comments for `on_receive`

* Updated concept topic for `depositWithMessage`

* Update components/Starknet/modules/tools/pages/starkgate-bridge.adoc

* Update components/Starknet/modules/tools/pages/starkgate-bridge.adoc

* Update starkgate-automated_actions_with_bridging.adoc

* Update components/Starknet/modules/tools/pages/starkgate-automated_actions_with_bridging.adoc

* Update components/Starknet/modules/tools/pages/starkgate-automated_actions_with_bridging.adoc

* L1 handler *transaction* -> L1 handler *function*

* docs: StarkGate function/event reference, architecture topic, procedural content. (#886)

* Adding a new topic with functions for StarkGate.

* Added blockToken

* Added deactivateToken

* Added more functions.

* Added getWithdrawalBridges.

* Renamed token-bridge.adoc to starkgate-bridge.adoc. Added entries to .htaccess.

* Add L2 functions.

* Added params to addExistingBridge.

* SME comment

* Minor fixes.

* Added more functions.

* More edits.

* Add getStatus

* Add Cancelling a deposit.

* Added deposit and depositReclaim

* Add table-striping to description lists for parameters and returns.

* Adding types to parameters.

* Adding event to `Deposit`

* Add depositWithMessage

* Updates to overview.

* Adding `depositWithMessage*` functions.

* SME comments

* depositWithMessage* functions.

* Moved desc of Manager and Registry to top of section.

* SME comments

* SME comments

* SME comments

* Added new topic: StarkGate architecture.

* Changed name of file from stargate_dev_reference.adoc to starkgate_function_reference.adoc; Removed info on adding a custom bridge from starkgate-adding_a_token.adoc.

* Updated starkgate_architecture.adoc.

* SME comments, cleaning up scattered links.

* Edit xref text for deposit function and event

* Edited name of reference doc

* Fixed broken xref.

* Added list of functions in each contract.

* Updated architecture topic.

* Removed the section on the Manager and the Registry. I don't think that this is helpful.

* Added AsciiDoc role to function heading in prep for adding style to make heading clearer.

* Updates to Architecture topic based on SME engineering and product feedback.

* Updates to function reference based on SME comments.

* Fixed typo.

* Added Visibility header.

* Consistency edits.

* Consistency edits.

---------

Co-authored-by: JameStark <113911244+JameStark@users.noreply.github.com>

* Added email address to contact for adding a custom bridge to StarkGate. (#923)

* docs: Add `on_receive` function interface and note about backward compatibility (#933)

* Add `on_receive` function interface.

* Add snippet_backwards_compatibiity_note.adoc with a note about backwards compatibility. Put note in:
starkgate_architecture.adoc
starkgate_function_reference.adoc
starkgate-bridge.adoc

* Started to add tagged regions for event descriptions to use same text as parameter descriptions.

* SME comments.

* Adding tagged regions for event params.

* Adding tagged regions for event params.

* Added concept topic explaining the depositWithMessage flow.

* SME comment

* SME Comments for `on_receive`

* Updated concept topic for `depositWithMessage`

* Update components/Starknet/modules/tools/pages/starkgate-bridge.adoc

* Update components/Starknet/modules/tools/pages/starkgate-bridge.adoc

* Update starkgate-automated_actions_with_bridging.adoc

* Update components/Starknet/modules/tools/pages/starkgate-automated_actions_with_bridging.adoc

* Update components/Starknet/modules/tools/pages/starkgate-automated_actions_with_bridging.adoc

* L1 handler *transaction* -> L1 handler *function*

* docs: Add table with list of bridged tokens (#1009)

* Add table with list of bridged tokens

* Removed TVL limitations from StarkGate overview.

---------

Co-authored-by: JameStark <113911244+JameStark@users.noreply.github.com>
stoobie added a commit that referenced this pull request Dec 19, 2023
…cedures (#922)

* docs: StarkGate function/event reference, architecture topic, procedural content. (#886)

* Adding a new topic with functions for StarkGate.

* Added blockToken

* Added deactivateToken

* Added more functions.

* Added getWithdrawalBridges.

* Renamed token-bridge.adoc to starkgate-bridge.adoc. Added entries to .htaccess.

* Add L2 functions.

* Added params to addExistingBridge.

* SME comment

* Minor fixes.

* Added more functions.

* More edits.

* Add getStatus

* Add Cancelling a deposit.

* Added deposit and depositReclaim

* Add table-striping to description lists for parameters and returns.

* Adding types to parameters.

* Adding event to `Deposit`

* Add depositWithMessage

* Updates to overview.

* Adding `depositWithMessage*` functions.

* SME comments

* depositWithMessage* functions.

* Moved desc of Manager and Registry to top of section.

* SME comments

* SME comments

* SME comments

* Added new topic: StarkGate architecture.

* Changed name of file from stargate_dev_reference.adoc to starkgate_function_reference.adoc; Removed info on adding a custom bridge from starkgate-adding_a_token.adoc.

* Updated starkgate_architecture.adoc.

* SME comments, cleaning up scattered links.

* Edit xref text for deposit function and event

* Edited name of reference doc

* Fixed broken xref.

* Added list of functions in each contract.

* Updated architecture topic.

* Removed the section on the Manager and the Registry. I don't think that this is helpful.

* Added AsciiDoc role to function heading in prep for adding style to make heading clearer.

* Updates to Architecture topic based on SME engineering and product feedback.

* Updates to function reference based on SME comments.

* Fixed typo.

* Added Visibility header.

* Consistency edits.

* Consistency edits.

---------

Co-authored-by: JameStark <113911244+JameStark@users.noreply.github.com>

* Added email address to contact for adding a custom bridge to StarkGate. (#923)

* docs: Add `on_receive` function interface and note about backward compatibility (#933)

* Add `on_receive` function interface.

* Add snippet_backwards_compatibiity_note.adoc with a note about backwards compatibility. Put note in:
starkgate_architecture.adoc
starkgate_function_reference.adoc
starkgate-bridge.adoc

* Started to add tagged regions for event descriptions to use same text as parameter descriptions.

* SME comments.

* Adding tagged regions for event params.

* Adding tagged regions for event params.

* Added concept topic explaining the depositWithMessage flow.

* SME comment

* SME Comments for `on_receive`

* Updated concept topic for `depositWithMessage`

* Update components/Starknet/modules/tools/pages/starkgate-bridge.adoc

* Update components/Starknet/modules/tools/pages/starkgate-bridge.adoc

* Update starkgate-automated_actions_with_bridging.adoc

* Update components/Starknet/modules/tools/pages/starkgate-automated_actions_with_bridging.adoc

* Update components/Starknet/modules/tools/pages/starkgate-automated_actions_with_bridging.adoc

* L1 handler *transaction* -> L1 handler *function*

* docs: StarkGate function/event reference, architecture topic, procedural content. (#886)

* Adding a new topic with functions for StarkGate.

* Added blockToken

* Added deactivateToken

* Added more functions.

* Added getWithdrawalBridges.

* Renamed token-bridge.adoc to starkgate-bridge.adoc. Added entries to .htaccess.

* Add L2 functions.

* Added params to addExistingBridge.

* SME comment

* Minor fixes.

* Added more functions.

* More edits.

* Add getStatus

* Add Cancelling a deposit.

* Added deposit and depositReclaim

* Add table-striping to description lists for parameters and returns.

* Adding types to parameters.

* Adding event to `Deposit`

* Add depositWithMessage

* Updates to overview.

* Adding `depositWithMessage*` functions.

* SME comments

* depositWithMessage* functions.

* Moved desc of Manager and Registry to top of section.

* SME comments

* SME comments

* SME comments

* Added new topic: StarkGate architecture.

* Changed name of file from stargate_dev_reference.adoc to starkgate_function_reference.adoc; Removed info on adding a custom bridge from starkgate-adding_a_token.adoc.

* Updated starkgate_architecture.adoc.

* SME comments, cleaning up scattered links.

* Edit xref text for deposit function and event

* Edited name of reference doc

* Fixed broken xref.

* Added list of functions in each contract.

* Updated architecture topic.

* Removed the section on the Manager and the Registry. I don't think that this is helpful.

* Added AsciiDoc role to function heading in prep for adding style to make heading clearer.

* Updates to Architecture topic based on SME engineering and product feedback.

* Updates to function reference based on SME comments.

* Fixed typo.

* Added Visibility header.

* Consistency edits.

* Consistency edits.

---------

Co-authored-by: JameStark <113911244+JameStark@users.noreply.github.com>

* Added email address to contact for adding a custom bridge to StarkGate. (#923)

* docs: Add `on_receive` function interface and note about backward compatibility (#933)

* Add `on_receive` function interface.

* Add snippet_backwards_compatibiity_note.adoc with a note about backwards compatibility. Put note in:
starkgate_architecture.adoc
starkgate_function_reference.adoc
starkgate-bridge.adoc

* Started to add tagged regions for event descriptions to use same text as parameter descriptions.

* SME comments.

* Adding tagged regions for event params.

* Adding tagged regions for event params.

* Added concept topic explaining the depositWithMessage flow.

* SME comment

* SME Comments for `on_receive`

* Updated concept topic for `depositWithMessage`

* Update components/Starknet/modules/tools/pages/starkgate-bridge.adoc

* Update components/Starknet/modules/tools/pages/starkgate-bridge.adoc

* Update starkgate-automated_actions_with_bridging.adoc

* Update components/Starknet/modules/tools/pages/starkgate-automated_actions_with_bridging.adoc

* Update components/Starknet/modules/tools/pages/starkgate-automated_actions_with_bridging.adoc

* docs: Add table with list of bridged tokens (#1009)

* Add table with list of bridged tokens

* Removed TVL limitations from StarkGate overview.

* Added estimateDepositFeeWei and estimateEnrollmentFeeWei functions in function reference. (#1031)

---------

Co-authored-by: JameStark <113911244+JameStark@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant