Add documentation for Software Transactional Memory (STM) in Effect

[sharno]

Type

• Refactor
• Feature
• Bug Fix
• Optimization
• Documentation Update

Description

Adding documentation for STM

Related

• Related Issue #
• Closes #

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
website-content	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 9, 2025 1:51am
website-landing	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 9, 2025 1:51am
website-proxy	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 9, 2025 1:51am

[vercel]

@sharno is attempting to deploy a commit to the Effect Team on Vercel.

A member of the Team first needs to authorize it.

[suddenlyGiovanni]

👏🏻 Wow, well done!

Minor nitpicking: According to @ethanniser's workshop, code within the scope of STM should be "pure." Would it be a good idea to draw the user's attention to this constraint?

References:

• https://github.com/ethanniser/effect-workshop/blob/main/src/part4-whatsnext/snippets/2-stm.ts

• https://github.com/ethanniser/effect-workshop/blob/main/slides/slides.md#stm

[IMax153]

cc @mikearnaldi for a review here

[sharno]

Minor nitpicking: According to @ethanniser's workshop, code within the scope of STM should be "pure." Would it be a good idea to draw the user's attention to this constraint?

References:

• https://github.com/ethanniser/effect-workshop/blob/main/src/part4-whatsnext/snippets/2-stm.ts

• https://github.com/ethanniser/effect-workshop/blob/main/slides/slides.md#stm

Thank you! If the idea of adding the STM page is generally accepted I can add more details from this workshop

[mikearnaldi]

Minor nitpicking: According to @ethanniser's workshop, code within the scope of STM should be "pure." Would it be a good idea to draw the user's attention to this constraint?
References:

• https://github.com/ethanniser/effect-workshop/blob/main/src/part4-whatsnext/snippets/2-stm.ts
• https://github.com/ethanniser/effect-workshop/blob/main/slides/slides.md#stm

Thank you! If the idea of adding the STM page is generally accepted I can add more details from this workshop

yes I'd be totally in favour of adding an STM page to the docs

[sharno]

@mikearnaldi @suddenlyGiovanni

Sweet!
I added a section about immutability
Also a section about other Transactional DSs

I think this is ready if you don't see other issues

[sharno]

Any chance to review this to get it merged?

[suddenlyGiovanni]

Any chance to review this to get it merged?

I know the primary focus is on "SMOL", but do we have any updates on this one @mikearnaldi?