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

Documentation for Orchestration API #1143

Open
rabi-siddique opened this issue Jul 9, 2024 · 1 comment
Open

Documentation for Orchestration API #1143

rabi-siddique opened this issue Jul 9, 2024 · 1 comment
Assignees

Comments

@rabi-siddique
Copy link
Contributor

rabi-siddique commented Jul 9, 2024

Description

We need documentation for the orchestration concepts specifically the ones used in the provided code examples to provide developers with clear and practical usage information. The following enhancements should be included:

1. Overview of API:

  • Explanation of core components its parameters.

2. Method Descriptions and Examples Usage:

This could a snippet from the examples code.

Action Items:

  • Create and merge documentation for the orchestration API.
  • Include clear code examples for each method.
  • Ensure all descriptions are accurate and provide sufficient context.
@dckc
Copy link
Member

dckc commented Jul 16, 2024

2. Method Descriptions and Examples Usage:

This could a snippet from the examples code.

Method descriptions belong in @agoric/orchestration | API documentation of Agoric SDK

It would be nice to have short examples there too.

But examples in docs.agoric.com are good too in any case. Especially tested snippets.

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

No branches or pull requests

2 participants