added Important Notice about the Marlowe Transition #193
Conversation
WalkthroughThe recent update to the Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Out of diff range and nitpick comments (5)
Readme.md (5)
Line range hint
29-29: Consider a shorter alternative to avoid wordiness.- In order to interact with Marlowe contracts, the **TS-SDK** needs a Runtime instance. + To interact with Marlowe contracts, the **TS-SDK** needs a Runtime instance.
Line range hint
38-38: Unpaired symbol: ‘]’ seems to be missing.- To get a running instance of the Runtime, it is recommended to check out the instructions on the [Marlowe Starter Kit](https://github.com/input-output-hk/marlowe-starter-kit) + To get a running instance of the Runtime, it is recommended to check out the instructions on the [Marlowe Starter Kit](https://github.com/input-output-hk/marlowe-starter-kit).
Line range hint
55-57: The official spelling of this programming framework is “Node.js”.- ### Lucid and NodeJS + ### Lucid and Node.js- This allows you to use the SDK in a NodeJS environment. + This allows you to use the SDK in a Node.js environment.
Line range hint
63-63: To make your writing flow more naturally, try moving ‘also’ between the auxiliary and the verb.- Prototypes have been also built on top of this sdk: + Prototypes have also been built on top of this sdk:
Line range hint
9-14: Images should have alternate text (alt text) for accessibility.- <a href="" target="blank_"> - <img src="./doc/image/logo.svg" alt="Logo" height="75"> - </a> - <a href=""><img src="https://img.shields.io/badge/stability-beta-33bbff.svg" alt="Beta"></a> - <a href="./LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg"></a> - <a href="https://discord.com/invite/cmveaxuzBn"><img src="https://img.shields.io/discord/826816523368005654?label=Chat%20on%20Discord"></a> + <a href="" target="blank_"> + <img src="./doc/image/logo.svg" alt="Marlowe SDK Logo" height="75"> + </a> + <a href=""><img src="https://img.shields.io/badge/stability-beta-33bbff.svg" alt="Beta Stability"></a> + <a href="./LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="Apache 2.0 License"></a> + <a href="https://discord.com/invite/cmveaxuzBn"><img src="https://img.shields.io/discord/826816523368005654?label=Chat%20on%20Discord" alt="Chat on Discord"></a>
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- Readme.md (1 hunks)
Additional Context Used
LanguageTool (5)
Readme.md (5)
Near line 29: Consider a shorter alternative to avoid wordiness.
Context: ....io/marlowe-ts-sdk/) page. ## Runtime In order to interact with Marlowe contracts, the **...
Near line 38: Unpaired symbol: ‘]’ seems to be missing
Context: ...ed to check out the instructions on the [Marlowe Starter Kit](https://github.com/...
Near line 55: The official spelling of this programming framework is “Node.js”.
Context: ... | ? | ### Lucid and NodeJS The SDK also provides a wrapper ar...
Near line 57: The official spelling of this programming framework is “Node.js”.
Context: ...ry. This allows you to use the SDK in a NodeJS environment. ## Examples & Contract Us...
Near line 63: To make your writing flow more naturally, try moving ‘also’ between the auxiliary and the verb.
Context: ...ferent packages of the SDK. Prototypes have been also built on top of this sdk: - Payouts ...
| > [!IMPORTANT] | ||
| > This Marlowe repository will soon be moved to https://github.com/marlowe-lang. The new repositories will be administered by an independent vehicle, a not-for-profit organization currently being set up by the transition team.<br> | ||
| > This will allow us to ensure community representation and stewardship. Future developments and support for Marlowe are transitioning to a community-driven model initially led by [Simon Thompson](https://github.com/simonjohnthompson), [Nicolas Henin](https://github.com/nhenin) and [Tomasz Rybarczyk](https://github.com/paluh). <br> | ||
| > See [here](https://github.com/marlowe-lang/.github/blob/main/profile/transition.md) for details. |
There was a problem hiding this comment.
Add a period at the end of the sentence for consistency.
- > See [here](https://github.com/marlowe-lang/.github/blob/main/profile/transition.md) for details.
+ > See [here](https://github.com/marlowe-lang/.github/blob/main/profile/transition.md) for details.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| > [!IMPORTANT] | |
| > This Marlowe repository will soon be moved to https://github.com/marlowe-lang. The new repositories will be administered by an independent vehicle, a not-for-profit organization currently being set up by the transition team.<br> | |
| > This will allow us to ensure community representation and stewardship. Future developments and support for Marlowe are transitioning to a community-driven model initially led by [Simon Thompson](https://github.com/simonjohnthompson), [Nicolas Henin](https://github.com/nhenin) and [Tomasz Rybarczyk](https://github.com/paluh). <br> | |
| > See [here](https://github.com/marlowe-lang/.github/blob/main/profile/transition.md) for details. | |
| > [!IMPORTANT] | |
| > This Marlowe repository will soon be moved to https://github.com/marlowe-lang. The new repositories will be administered by an independent vehicle, a not-for-profit organization currently being set up by the transition team.<br> | |
| > This will allow us to ensure community representation and stewardship. Future developments and support for Marlowe are transitioning to a community-driven model initially led by [Simon Thompson](https://github.com/simonjohnthompson), [Nicolas Henin](https://github.com/nhenin) and [Tomasz Rybarczyk](https://github.com/paluh). <br> | |
| > See [here](https://github.com/marlowe-lang/.github/blob/main/profile/transition.md) for details. |
| > [!IMPORTANT] | ||
| > This Marlowe repository will soon be moved to https://github.com/marlowe-lang. The new repositories will be administered by an independent vehicle, a not-for-profit organization currently being set up by the transition team.<br> | ||
| > This will allow us to ensure community representation and stewardship. Future developments and support for Marlowe are transitioning to a community-driven model initially led by [Simon Thompson](https://github.com/simonjohnthompson), [Nicolas Henin](https://github.com/nhenin) and [Tomasz Rybarczyk](https://github.com/paluh). <br> | ||
| > See [here](https://github.com/marlowe-lang/.github/blob/main/profile/transition.md) for details. | ||
|
|
||
|
|
||
|
|
There was a problem hiding this comment.
Remove trailing spaces and reduce multiple consecutive blank lines for cleaner formatting.
- > [!IMPORTANT]
- > This Marlowe repository will soon be moved to https://github.com/marlowe-lang. The new repositories will be administered by an independent vehicle, a not-for-profit organization currently being set up by the transition team.<br>
- > This will allow us to ensure community representation and stewardship. Future developments and support for Marlowe are transitioning to a community-driven model initially led by [Simon Thompson](https://github.com/simonjohnthompson), [Nicolas Henin](https://github.com/nhenin) and [Tomasz Rybarczyk](https://github.com/paluh). <br>
- > See [here](https://github.com/marlowe-lang/.github/blob/main/profile/transition.md) for details.
-
-
-
+ > [!IMPORTANT]
+ > This Marlowe repository will soon be moved to https://github.com/marlowe-lang. The new repositories will be administered by an independent vehicle, a not-for-profit organization currently being set up by the transition team.<br>
+ > This will allow us to ensure community representation and stewardship. Future developments and support for Marlowe are transitioning to a community-driven model initially led by [Simon Thompson](https://github.com/simonjohnthompson), [Nicolas Henin](https://github.com/nhenin) and [Tomasz Rybarczyk](https://github.com/paluh).<br>
+ > See [here](https://github.com/marlowe-lang/.github/blob/main/profile/transition.md) for details.
+Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| > [!IMPORTANT] | |
| > This Marlowe repository will soon be moved to https://github.com/marlowe-lang. The new repositories will be administered by an independent vehicle, a not-for-profit organization currently being set up by the transition team.<br> | |
| > This will allow us to ensure community representation and stewardship. Future developments and support for Marlowe are transitioning to a community-driven model initially led by [Simon Thompson](https://github.com/simonjohnthompson), [Nicolas Henin](https://github.com/nhenin) and [Tomasz Rybarczyk](https://github.com/paluh). <br> | |
| > See [here](https://github.com/marlowe-lang/.github/blob/main/profile/transition.md) for details. | |
| > [!IMPORTANT] | |
| > This Marlowe repository will soon be moved to https://github.com/marlowe-lang. The new repositories will be administered by an independent vehicle, a not-for-profit organization currently being set up by the transition team.<br> | |
| > This will allow us to ensure community representation and stewardship. Future developments and support for Marlowe are transitioning to a community-driven model initially led by [Simon Thompson](https://github.com/simonjohnthompson), [Nicolas Henin](https://github.com/nhenin) and [Tomasz Rybarczyk](https://github.com/paluh).<br> | |
| > See [here](https://github.com/marlowe-lang/.github/blob/main/profile/transition.md) for details. |
| </div> | ||
|
|
||
| > [!IMPORTANT] | ||
| > This Marlowe repository will soon be moved to https://github.com/marlowe-lang. The new repositories will be administered by an independent vehicle, a not-for-profit organization currently being set up by the transition team.<br> |
There was a problem hiding this comment.
Avoid using bare URLs. Consider embedding the URL in a descriptive text.
- > This Marlowe repository will soon be moved to https://github.com/marlowe-lang. The new repositories will be administered by an independent vehicle, a not-for-profit organization currently being set up by the transition team.<br>
+ > This Marlowe repository will soon be moved to [the new Marlowe organization on GitHub](https://github.com/marlowe-lang). The new repositories will be administered by an independent vehicle, a not-for-profit organization currently being set up by the transition team.<br>Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| > This Marlowe repository will soon be moved to https://github.com/marlowe-lang. The new repositories will be administered by an independent vehicle, a not-for-profit organization currently being set up by the transition team.<br> | |
| > This Marlowe repository will soon be moved to [the new Marlowe organization on GitHub](https://github.com/marlowe-lang). The new repositories will be administered by an independent vehicle, a not-for-profit organization currently being set up by the transition team.<br> |
Summary by CodeRabbit