Add more context and links to app dev docs #1149
Conversation
meiersi-da
force-pushed
the
meiersi/tie-app-dev-docs-to-da-docs
branch
from
9b8b372 to
7d054cd
Compare
meiersi-da
changed the title
meiersi-da
force-pushed
the
meiersi/tie-app-dev-docs-to-da-docs
branch
3 times, most recently
from
d2d50fd to
2e6d4dc
Compare
meiersi-da
force-pushed
the
meiersi/tie-app-dev-docs-to-da-docs
branch
from
7052a69 to
412ccb3
Compare
meiersi-da
force-pushed
the
meiersi/tie-app-dev-docs-to-da-docs
branch
from
a2ca638 to
98b56d4
Compare
- improve ToC and contextualize the different APIs - link to Digital Asset docs for CN app dev - clarify version information and SDK installation [ci] Signed-off-by: Simon Meier <[email protected]>
Co-authored-by: moritzkiefer-da <[email protected]> Signed-off-by: Simon Meier <[email protected]>
[ci] Signed-off-by: Simon Meier <[email protected]>
[no ci] Co-authored-by: Raymond Roestenburg <[email protected]> Signed-off-by: Simon Meier <[email protected]>
Signed-off-by: Simon Meier <[email protected]>
meiersi-da
force-pushed
the
meiersi/tie-app-dev-docs-to-da-docs
branch
from
98b56d4 to
61ec515
Compare
|
|
||
| .. image:: ../../validator_operator/images/validator-network-diagram.png | ||
| :width: 600 | ||
| :alt: Validator Network Diagram |
There was a problem hiding this comment.
I don't think the "Validator Network Diagram" is sufficient. The VND is an infrastructure diagram. It doesn't describe the software architecture and the API endpoints. I realized this when I asked "Where is the application?" in the picture that is about "how to deploy a validator using Helm charts." I have a very high conviction that this is needed.
| - use the token standard | ||
| - mention the `AppPaymentRequestFlow` as deprecated | ||
| - clearly mark splice subscription API as deprecated | ||
| Splice defines Daml APIs that decouple different applications on the Canton Network. |
There was a problem hiding this comment.
I find this sentence confusing: "Splice defines Daml APIs that decouple different applications on the Canton Network."
My mental model is that "Splice includes interoperability standards that are intended to reduce coupling between applications. These standards and reference implementations are provided as Daml models."
I find the decoupling is a secondary aspect that is an intended side-effect.
@ray-roestenburg-da @hrischuk-da: could I ask you for a review please :)
I suggest building the docs locally to review them more easily:
TODO:
Pull Request Checklist
Cluster Testing
/cluster_teston this PR to request it, and ping someone with access to the DA-internal system to approve it./hdm_teston this PR to request it, and ping someone with access to the DA-internal system to approve it.PR Guidelines
Fixes #n, and mention issues worked on using#nMerge Guidelines