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

Orchestration landing page doc update for launch #1235

Merged
merged 6 commits into from
Oct 8, 2024

Conversation

Jovonni
Copy link
Contributor

@Jovonni Jovonni commented Oct 7, 2024

updated the entrypoint guide landing page for orchestration docs from internal feedback.

@Jovonni Jovonni self-assigned this Oct 7, 2024
Copy link

cloudflare-workers-and-pages bot commented Oct 7, 2024

Deploying documentation with  Cloudflare Pages  Cloudflare Pages

Latest commit: ed44067
Status: ✅  Deploy successful!
Preview URL: https://41bf3b55.documentation-7tp.pages.dev
Branch Preview URL: https://jo-orchestration-launch-docs.documentation-7tp.pages.dev

View logs

@Jovonni Jovonni force-pushed the jo/orchestration-launch-docs-updates branch from 8901cb4 to 2e1bb61 Compare October 7, 2024 21:16
@Jovonni Jovonni requested review from amessbee and mujahidkay October 7, 2024 21:19
@Jovonni Jovonni marked this pull request as ready for review October 7, 2024 21:23
@Jovonni Jovonni marked this pull request as draft October 7, 2024 21:24
Copy link
Member

@mujahidkay mujahidkay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor suggestions for consistency

main/guides/orchestration/index.md Show resolved Hide resolved
main/guides/orchestration/index.md Outdated Show resolved Hide resolved
Copy link
Member

@mujahidkay mujahidkay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

on a second look? I think we should match the navbar entry with this.

Also, we need to change Orchestration Overview to an h2. Can't have two h1s.

@Jovonni Jovonni marked this pull request as ready for review October 8, 2024 14:14
main/guides/orchestration/index.md Outdated Show resolved Hide resolved
main/guides/orchestration/index.md Outdated Show resolved Hide resolved
main/guides/orchestration/index.md Outdated Show resolved Hide resolved

- **Remote account control and transfer**: Use the Orchestration APIs to easily create accounts on remote chains, transfer assets, and invoke contracts. Your Agoric contract orchestrates all behavior directly.
- **Multiblock execution with async & await**: Agoric applications communicate asynchronously and await responses which may come in the same block or many blocks (or weeks!) later. Contracts simply continue executing when the response arrives.
- **On-chain Timers**: Contracts can set timers for regular execution which makes executing common activities like subscriptions easy.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **On-chain Timers**: Contracts can set timers for regular execution which makes executing common activities like subscriptions easy.
- **On-chain Timers**: Contracts can set timers for regular execution which makes scheduling execution of common activities like subscriptions easy.

main/guides/orchestration/index.md Outdated Show resolved Hide resolved
- **Multiblock execution with async & await**: Agoric applications communicate asynchronously and await responses which may come in the same block or many blocks (or weeks!) later. Contracts simply continue executing when the response arrives.
- **On-chain Timers**: Contracts can set timers for regular execution which makes executing common activities like subscriptions easy.

Agoric’s Orchestration API simplifies controlling remote chains, moving assets, and using capabilities on any chain the API reaches.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

any chain the API reaches sounds very informal - it's fine if marketing is onboard with it.

@amessbee
Copy link
Contributor

amessbee commented Oct 8, 2024

left a few nit comments - looks like a great improvement overall!

@Jovonni Jovonni requested review from amessbee and mujahidkay October 8, 2024 17:32
Copy link
Contributor

@amessbee amessbee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm - nice work!

Copy link
Member

@mujahidkay mujahidkay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good stuff!

@Jovonni Jovonni merged commit cebe1ff into main Oct 8, 2024
6 checks passed
@Jovonni Jovonni deleted the jo/orchestration-launch-docs-updates branch October 8, 2024 18:17
@Jovonni Jovonni restored the jo/orchestration-launch-docs-updates branch October 8, 2024 18:17
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