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

fix(docs): Documentation Corrections for Bridge Contract and Integration Manual #15144

Merged
merged 2 commits into from
Nov 9, 2023

Conversation

SamiAlHassan
Copy link
Contributor

Overview

This pull request includes documentation updates to enhance clarity and correct verb tense issues. Two files have been modified with improvements to the descriptions and instructions provided.

Changes Made

  • In Bridge.md, the description for the return value of the shouldCheckProof function has been clarified. The previous description was somewhat ambiguous, and now it clearly states the function's behavior in different environments (commit 01d7058).

  • In integration-manual.mdx, a verb tense error in the introduction sentence was corrected to improve the reading flow and grammatical accuracy (commit 05d52e7).

Files Affected

  • packages/website/pages/docs/reference/contract-documentation/bridge/Bridge.md
  • packages/website/pages/docs/manuals/integration-manual.mdx

The updates aim to remove any potential confusion for readers and ensure that the documentation adheres to standard English grammar rules.

Copy link

vercel bot commented Nov 7, 2023

@SamiAlHassan is attempting to deploy a commit to the taikoxyz Team on Vercel.

A member of the Team first needs to authorize it.

@dantaik dantaik enabled auto-merge November 9, 2023 07:00
@dantaik dantaik requested a review from adaki2004 November 9, 2023 07:00
@dantaik dantaik changed the title Documentation Corrections for Bridge Contract and Integration Manual fix(docs): Documentation Corrections for Bridge Contract and Integration Manual Nov 9, 2023
@dantaik dantaik added this pull request to the merge queue Nov 9, 2023
Merged via the queue into taikoxyz:main with commit 4c5c1b9 Nov 9, 2023
1 check failed
Copy link

gitpoap-bot bot commented Nov 9, 2023

Congrats, your important contribution to this open-source project has earned you a GitPOAP!

GitPOAP: 2023 Taiko Contributor:

GitPOAP: 2023 Taiko Contributor GitPOAP Badge

Head to gitpoap.io & connect your GitHub account to mint!

Learn more about GitPOAPs here.

@github-actions github-actions bot mentioned this pull request Nov 9, 2023
KorbinianK added a commit that referenced this pull request Nov 22, 2023
commit 99aa5a0
Author: 0xhwk <85083631+0xhwk@users.noreply.github.com>
Date:   Wed Nov 22 16:12:44 2023 +0300

    docs(website): changed chainlist link to list taiko chains and testnets (#15212)

    Co-authored-by: dave <13951458+d1onys1us@users.noreply.github.com>

commit d634f16
Author: TABASCO <84655644+TABASCOatw@users.noreply.github.com>
Date:   Wed Nov 22 06:12:05 2023 -0700

    chore(website): Adds Particle Taiko Onboarding to learning-resources (#15032)

commit 989cd2a
Author: Szymon Wolny <32844693+szymcio32@users.noreply.github.com>
Date:   Wed Nov 22 10:19:06 2023 +0100

    docs(website): update reference docs (#15018)

    Co-authored-by: Roger <50648015+RogerLamTd@users.noreply.github.com>

commit a088b3e
Author: Suresh <39760546+hausuresh@users.noreply.github.com>
Date:   Wed Nov 22 11:15:09 2023 +0700

    Update prover-market-page.mdx (#15239)

commit e07ed4d
Author: Bennett Yong <36499389+bennettyong@users.noreply.github.com>
Date:   Tue Nov 21 22:36:43 2023 +0800

    refactor: prover market page (#15237)

commit 462149c
Author: ptchela <80599907+ptchela@users.noreply.github.com>
Date:   Thu Nov 16 18:14:29 2023 +0100

    refactor(bridge-ui-v2): Optimize bridge config generation logic (#15194)

commit ddc8447
Author: CodeDragonVN <150457827+CodeDragonVN@users.noreply.github.com>
Date:   Mon Nov 13 07:55:01 2023 +0000

    docs(website,protocol): Correct Documentation Descriptions in ICrossChainSync and IProver (#15189)

    Co-authored-by: dave <13951458+d1onys1us@users.noreply.github.com>

commit 4a7c925
Author: Kenk <kenghin_lim@hotmail.com>
Date:   Mon Nov 13 08:14:18 2023 +0300

    feat(website): update prover endpoints (#15195)

commit f9ab9f0
Author: Olga Skraglenko <112018952+l2genius@users.noreply.github.com>
Date:   Sun Nov 12 21:07:34 2023 +0100

    docs(website): Update prover-market-page.mdx (#15175)

    Co-authored-by: dave <13951458+d1onys1us@users.noreply.github.com>

commit f5304b2
Author: zEustace <115109332+zEustace@users.noreply.github.com>
Date:   Sun Nov 12 16:55:56 2023 -0300

    docs(website): Update run-a-sepolia-node.mdx (#15160)

    Co-authored-by: dave <13951458+d1onys1us@users.noreply.github.com>

commit 05a9f46
Author: 0xoats <106729827+0xoats@users.noreply.github.com>
Date:   Mon Nov 13 03:06:03 2023 +0800

    docs(website): update prover-market-page (#15163)

    Co-authored-by: dave <13951458+d1onys1us@users.noreply.github.com>

commit 96abcf1
Author: acebryant08 <141197986+acebryant08@users.noreply.github.com>
Date:   Mon Nov 13 03:04:48 2023 +0800

    docs(website): Update prover-market-page.mdx (#15193)

commit a104926
Author: MariesAmbrosio <94685088+MariesAmbrosio@users.noreply.github.com>
Date:   Sun Nov 12 14:08:17 2023 +0800

    docs(website): Update prover-market-page.mdx (#15178)

commit e9b82ea
Author: Korbinian <KorbinianK@users.noreply.github.com>
Date:   Sun Nov 12 04:01:40 2023 +0300

    fix(bridge-ui-v2): processing fee and recipient not sticking (#15125)

    Co-authored-by: Daniel Wang <99078276+dantaik@users.noreply.github.com>

commit a0b3cbe
Author: Ohmarkely <37029890+Ohmarkely@users.noreply.github.com>
Date:   Sat Nov 11 01:18:23 2023 +0800

    docs(website): Update prover-market-page.mdx (#15150)

    Co-authored-by: Roger <50648015+RogerLamTd@users.noreply.github.com>

commit f561a8c
Author: Canarias96 <139697676+Canarias96@users.noreply.github.com>
Date:   Fri Nov 10 12:37:51 2023 +0000

    chore(website): Update prover-market-page.mdx (#15171)

    Co-authored-by: dave <13951458+d1onys1us@users.noreply.github.com>
    Co-authored-by: Roger <50648015+RogerLamTd@users.noreply.github.com>

commit b05279c
Author: VadimSMG <106158663+VadimSMG@users.noreply.github.com>
Date:   Fri Nov 10 14:09:27 2023 +0200

    docs(website): Update prover-market-page.mdx (#15168)

    Co-authored-by: dave <13951458+d1onys1us@users.noreply.github.com>
    Co-authored-by: David <david@taiko.xyz>

commit 7b994dd
Author: Shao Ming Xing <shaomxing@gmail.com>
Date:   Fri Nov 10 20:08:58 2023 +0800

    docs(protocol): fix some typos (#15174)

    Co-authored-by: shaomingxing <shaomingxing@qiyi.com>

commit f6b6f5f
Author: Mickaël Schoentgen <contact@tiger-222.fr>
Date:   Fri Nov 10 08:51:26 2023 +0100

    fix(website): Link to the Taiko Swap v3 (#15138)

commit 926ac5c
Author: zEustace <115109332+zEustace@users.noreply.github.com>
Date:   Thu Nov 9 12:47:30 2023 -0300

    Update prover-market-page.mdx (#15156)

commit 4c5c1b9
Author: SamiAlHassan <150172180+SamiAlHassan@users.noreply.github.com>
Date:   Thu Nov 9 15:44:10 2023 +0000

    fix(docs): Documentation Corrections for Bridge Contract and Integration Manual (#15144)

commit 361e98b
Author: shak58 <150069539+shak58@users.noreply.github.com>
Date:   Thu Nov 9 03:55:42 2023 +0000

    Fix typos in RLP decoding and transaction splitting documentation (#15141)

    Co-authored-by: Roger <50648015+RogerLamTd@users.noreply.github.com>

commit a062249
Author: Dedok1 <87876618+Dedok1@users.noreply.github.com>
Date:   Thu Nov 9 06:51:46 2023 +0300

    Update prover-market-page.mdx (#15149)

commit b91cc1a
Author: iwantanode <87604944+tudorpintea999@users.noreply.github.com>
Date:   Tue Nov 7 18:53:04 2023 +0200

    fix(README.md): minor typos (#15139)

    Co-authored-by: Roger <50648015+RogerLamTd@users.noreply.github.com>

commit 201384f
Author: Crytobike <123457728+cryptobike07@users.noreply.github.com>
Date:   Wed Nov 8 00:37:11 2023 +0800

    Update prover-market-page.mdx (#15118)

    Co-authored-by: Roger <50648015+RogerLamTd@users.noreply.github.com>

commit 071ba20
Author: Ivan Pospelov <107742812+jwelrynewone@users.noreply.github.com>
Date:   Tue Nov 7 19:31:39 2023 +0300

    Update prover-market-page.mdx (#15142)

    Co-authored-by: Roger <50648015+RogerLamTd@users.noreply.github.com>

commit f1a4701
Author: oktay Aslan <43525005+flechemano@users.noreply.github.com>
Date:   Tue Nov 7 19:29:10 2023 +0300

    Update prover-market-page.mdx (#15121)

    Co-authored-by: Roger <50648015+RogerLamTd@users.noreply.github.com>

commit 0e1d223
Author: mahamb <32960011+mahamb@users.noreply.github.com>
Date:   Wed Nov 8 00:24:23 2023 +0800

    Update prover-market-page.mdx (#15137)

    Co-authored-by: Roger <50648015+RogerLamTd@users.noreply.github.com>

commit b4f1121
Author: 0xBaka <107140614+0xBaka@users.noreply.github.com>
Date:   Tue Nov 7 17:20:04 2023 +0100

    docs(website): Update prover-market-page.mdx (#15135)

    Co-authored-by: Roger <50648015+RogerLamTd@users.noreply.github.com>

commit 9da9e39
Author: Arthas <101375007+Azkalatihan@users.noreply.github.com>
Date:   Tue Nov 7 16:16:20 2023 +0000

    docs(website): Update prover-market-page.mdx (#15140)

commit e144b75
Author: MartinKong1990 <104483650+MartinKong1990@users.noreply.github.com>
Date:   Mon Nov 6 23:19:21 2023 +0800

    feat(website):  Fix Broken Link for Meta Merge in EcosystemSection.tsx (#15126)
KorbinianK added a commit that referenced this pull request Nov 22, 2023
commit 99aa5a0
Author: 0xhwk <85083631+0xhwk@users.noreply.github.com>
Date:   Wed Nov 22 16:12:44 2023 +0300

    docs(website): changed chainlist link to list taiko chains and testnets (#15212)

    Co-authored-by: dave <13951458+d1onys1us@users.noreply.github.com>

commit d634f16
Author: TABASCO <84655644+TABASCOatw@users.noreply.github.com>
Date:   Wed Nov 22 06:12:05 2023 -0700

    chore(website): Adds Particle Taiko Onboarding to learning-resources (#15032)

commit 989cd2a
Author: Szymon Wolny <32844693+szymcio32@users.noreply.github.com>
Date:   Wed Nov 22 10:19:06 2023 +0100

    docs(website): update reference docs (#15018)

    Co-authored-by: Roger <50648015+RogerLamTd@users.noreply.github.com>

commit a088b3e
Author: Suresh <39760546+hausuresh@users.noreply.github.com>
Date:   Wed Nov 22 11:15:09 2023 +0700

    Update prover-market-page.mdx (#15239)

commit e07ed4d
Author: Bennett Yong <36499389+bennettyong@users.noreply.github.com>
Date:   Tue Nov 21 22:36:43 2023 +0800

    refactor: prover market page (#15237)

commit 462149c
Author: ptchela <80599907+ptchela@users.noreply.github.com>
Date:   Thu Nov 16 18:14:29 2023 +0100

    refactor(bridge-ui-v2): Optimize bridge config generation logic (#15194)

commit ddc8447
Author: CodeDragonVN <150457827+CodeDragonVN@users.noreply.github.com>
Date:   Mon Nov 13 07:55:01 2023 +0000

    docs(website,protocol): Correct Documentation Descriptions in ICrossChainSync and IProver (#15189)

    Co-authored-by: dave <13951458+d1onys1us@users.noreply.github.com>

commit 4a7c925
Author: Kenk <kenghin_lim@hotmail.com>
Date:   Mon Nov 13 08:14:18 2023 +0300

    feat(website): update prover endpoints (#15195)

commit f9ab9f0
Author: Olga Skraglenko <112018952+l2genius@users.noreply.github.com>
Date:   Sun Nov 12 21:07:34 2023 +0100

    docs(website): Update prover-market-page.mdx (#15175)

    Co-authored-by: dave <13951458+d1onys1us@users.noreply.github.com>

commit f5304b2
Author: zEustace <115109332+zEustace@users.noreply.github.com>
Date:   Sun Nov 12 16:55:56 2023 -0300

    docs(website): Update run-a-sepolia-node.mdx (#15160)

    Co-authored-by: dave <13951458+d1onys1us@users.noreply.github.com>

commit 05a9f46
Author: 0xoats <106729827+0xoats@users.noreply.github.com>
Date:   Mon Nov 13 03:06:03 2023 +0800

    docs(website): update prover-market-page (#15163)

    Co-authored-by: dave <13951458+d1onys1us@users.noreply.github.com>

commit 96abcf1
Author: acebryant08 <141197986+acebryant08@users.noreply.github.com>
Date:   Mon Nov 13 03:04:48 2023 +0800

    docs(website): Update prover-market-page.mdx (#15193)

commit a104926
Author: MariesAmbrosio <94685088+MariesAmbrosio@users.noreply.github.com>
Date:   Sun Nov 12 14:08:17 2023 +0800

    docs(website): Update prover-market-page.mdx (#15178)

commit e9b82ea
Author: Korbinian <KorbinianK@users.noreply.github.com>
Date:   Sun Nov 12 04:01:40 2023 +0300

    fix(bridge-ui-v2): processing fee and recipient not sticking (#15125)

    Co-authored-by: Daniel Wang <99078276+dantaik@users.noreply.github.com>

commit a0b3cbe
Author: Ohmarkely <37029890+Ohmarkely@users.noreply.github.com>
Date:   Sat Nov 11 01:18:23 2023 +0800

    docs(website): Update prover-market-page.mdx (#15150)

    Co-authored-by: Roger <50648015+RogerLamTd@users.noreply.github.com>

commit f561a8c
Author: Canarias96 <139697676+Canarias96@users.noreply.github.com>
Date:   Fri Nov 10 12:37:51 2023 +0000

    chore(website): Update prover-market-page.mdx (#15171)

    Co-authored-by: dave <13951458+d1onys1us@users.noreply.github.com>
    Co-authored-by: Roger <50648015+RogerLamTd@users.noreply.github.com>

commit b05279c
Author: VadimSMG <106158663+VadimSMG@users.noreply.github.com>
Date:   Fri Nov 10 14:09:27 2023 +0200

    docs(website): Update prover-market-page.mdx (#15168)

    Co-authored-by: dave <13951458+d1onys1us@users.noreply.github.com>
    Co-authored-by: David <david@taiko.xyz>

commit 7b994dd
Author: Shao Ming Xing <shaomxing@gmail.com>
Date:   Fri Nov 10 20:08:58 2023 +0800

    docs(protocol): fix some typos (#15174)

    Co-authored-by: shaomingxing <shaomingxing@qiyi.com>

commit f6b6f5f
Author: Mickaël Schoentgen <contact@tiger-222.fr>
Date:   Fri Nov 10 08:51:26 2023 +0100

    fix(website): Link to the Taiko Swap v3 (#15138)

commit 926ac5c
Author: zEustace <115109332+zEustace@users.noreply.github.com>
Date:   Thu Nov 9 12:47:30 2023 -0300

    Update prover-market-page.mdx (#15156)

commit 4c5c1b9
Author: SamiAlHassan <150172180+SamiAlHassan@users.noreply.github.com>
Date:   Thu Nov 9 15:44:10 2023 +0000

    fix(docs): Documentation Corrections for Bridge Contract and Integration Manual (#15144)

commit 361e98b
Author: shak58 <150069539+shak58@users.noreply.github.com>
Date:   Thu Nov 9 03:55:42 2023 +0000

    Fix typos in RLP decoding and transaction splitting documentation (#15141)

    Co-authored-by: Roger <50648015+RogerLamTd@users.noreply.github.com>

commit a062249
Author: Dedok1 <87876618+Dedok1@users.noreply.github.com>
Date:   Thu Nov 9 06:51:46 2023 +0300

    Update prover-market-page.mdx (#15149)

commit b91cc1a
Author: iwantanode <87604944+tudorpintea999@users.noreply.github.com>
Date:   Tue Nov 7 18:53:04 2023 +0200

    fix(README.md): minor typos (#15139)

    Co-authored-by: Roger <50648015+RogerLamTd@users.noreply.github.com>

commit 201384f
Author: Crytobike <123457728+cryptobike07@users.noreply.github.com>
Date:   Wed Nov 8 00:37:11 2023 +0800

    Update prover-market-page.mdx (#15118)

    Co-authored-by: Roger <50648015+RogerLamTd@users.noreply.github.com>

commit 071ba20
Author: Ivan Pospelov <107742812+jwelrynewone@users.noreply.github.com>
Date:   Tue Nov 7 19:31:39 2023 +0300

    Update prover-market-page.mdx (#15142)

    Co-authored-by: Roger <50648015+RogerLamTd@users.noreply.github.com>

commit f1a4701
Author: oktay Aslan <43525005+flechemano@users.noreply.github.com>
Date:   Tue Nov 7 19:29:10 2023 +0300

    Update prover-market-page.mdx (#15121)

    Co-authored-by: Roger <50648015+RogerLamTd@users.noreply.github.com>

commit 0e1d223
Author: mahamb <32960011+mahamb@users.noreply.github.com>
Date:   Wed Nov 8 00:24:23 2023 +0800

    Update prover-market-page.mdx (#15137)

    Co-authored-by: Roger <50648015+RogerLamTd@users.noreply.github.com>

commit b4f1121
Author: 0xBaka <107140614+0xBaka@users.noreply.github.com>
Date:   Tue Nov 7 17:20:04 2023 +0100

    docs(website): Update prover-market-page.mdx (#15135)

    Co-authored-by: Roger <50648015+RogerLamTd@users.noreply.github.com>

commit 9da9e39
Author: Arthas <101375007+Azkalatihan@users.noreply.github.com>
Date:   Tue Nov 7 16:16:20 2023 +0000

    docs(website): Update prover-market-page.mdx (#15140)

commit e144b75
Author: MartinKong1990 <104483650+MartinKong1990@users.noreply.github.com>
Date:   Mon Nov 6 23:19:21 2023 +0800

    feat(website):  Fix Broken Link for Meta Merge in EcosystemSection.tsx (#15126)
@github-actions github-actions bot mentioned this pull request Feb 9, 2024
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.

3 participants