Agoric / documentation

User documentation

https://agoric.com/documentation/

Apache License 2.0

15 stars 39 forks source link

Documentation for Orchestration API #1143

Open rabi-siddique opened 2 months ago

rabi-siddique commented 2 months ago

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 commented 2 months ago

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.