Orch Docs Landing Page Clarity, Add transactional vs portfolio

[amessbee]

Ref: #1272

• Updated the Orch docs landing page for clarity
• Add code examples
• Add transactional vs portfolio page

Here are pages of interest:

• https://ms-update-orch-docs.documentation-7tp.pages.dev/guides/orchestration/
• https://ms-update-orch-docs.documentation-7tp.pages.dev/guides/orchestration/txvsportfolio.html

[cloudflare-workers-and-pages]

Deploying documentation with    Cloudflare Pages

Latest commit:	f1b6b5c
Status:	✅  Deploy successful!
Preview URL:	https://a018925e.documentation-7tp.pages.dev
Branch Preview URL:	https://ms-update-orch-docs.documentation-7tp.pages.dev

View logs

[github-actions]

Cloudflare deployment logs are available here

[amessbee]

@dtribble This is a draft but do you think this is a step in the right direction? Also, please share any specific comments.

[dckc]

comments marked correctness are critical

[dckc]

This doesn't seem to be a screenshot or continuous-tone image. It's circles and arrows and such. Do we have an .svg version? How was it drawn? How do we maintain it?

[amessbee]

It was generated in free version of canva so we could not get the SVG.

This image has been here for a few months now - if you recall we had a slack discussion about this with Touseef.

[dckc]

ah yes. now I remember.
Maybe it's worth a comment to say "drawn with canva which does not export SVG" so I don't trip over it again?

or maybe we can convert it... hm... I tried a couple quick tools; no luck.

[dckc]

good stuff

I leave it up to you to decide whether to wait for @Chris-Hibbert to weigh in. I expect we can tweak later if it comes to that.

[Chris-Hibbert]

I've drawn a similar distinction to the idea of transactional vs portfolio here, but I don't think this represents two kinds of contracts. For instance, FastUSDC has both kinds of interactions. The LP holders have a long-term position, while the traders never talk directly to the contract. Their funds are deposited in a seat, but there isn't a separate seat per transaction.

I think of it more as a spectrum. or different types of behavior that a contract can support.

[amessbee]

I've drawn a similar distinction to the idea of transactional vs portfolio here, but I don't think this represents two kinds of contracts. For instance, FastUSDC has both kinds of interactions. The LP holders have a long-term position, while the traders never talk directly to the contract. Their funds are deposited in a seat, but there isn't a separate seat per transaction.

I think of it more as a spectrum. or different types of behavior that a contract can support.

@Chris-Hibbert I am adding the following comment in the conclusion:

Note that rather than a rigid dichotomy, many contracts exist on a
spectrum supporting both interaction types. For instance, the FastUSDC contract supports both
portfolio-style LP positions and transactional trades without persistent user state.

[Muneeb147]

@amessbee Is there any thread/issue where this improvement is pre-discussed? Just wanted to review changes with the context