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

User documentation of daml2ts #4196

Merged
merged 1 commit into from
Jan 27, 2020
Merged

Conversation

shayne-fletcher
Copy link
Contributor

Add user facing documentation explaining daml2ts.

Copy link
Contributor

@hurryabit hurryabit left a comment

Choose a reason for hiding this comment

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

Nice work so far. Thanks.

As I mentioned multiple times, I consider this decoder business an implementation detail. It's also not really relevant if you want to use this library in the way we recommend with the @daml/ledger library. This library uses the decoder functions and our users don't need to care about this at all.

The documentation at the type level looks fantastic.

docs/source/daml2ts/index.rst Outdated Show resolved Hide resolved
docs/source/daml2ts/index.rst Outdated Show resolved Hide resolved
docs/source/daml2ts/index.rst Outdated Show resolved Hide resolved
docs/source/daml2ts/index.rst Outdated Show resolved Hide resolved
docs/source/daml2ts/index.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@cocreature cocreature left a comment

Choose a reason for hiding this comment

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

Awesome, thank you so much!

I would recommend that once we have the different sections, we rearrange this a bit to move the more reference-style documentation somewhere to the end and start with a simple example of “Here is your daml model, invoke the codegen, this is how you create a template and call a choice”. That should get people started very quickly and then the reference documentation starts to become useful once you take a more detailed look.

docs/source/daml2ts/index.rst Outdated Show resolved Hide resolved
docs/source/daml2ts/index.rst Outdated Show resolved Hide resolved
docs/source/daml2ts/index.rst Outdated Show resolved Hide resolved
docs/source/daml2ts/index.rst Outdated Show resolved Hide resolved
docs/source/daml2ts/index.rst Outdated Show resolved Hide resolved
docs/source/daml2ts/index.rst Outdated Show resolved Hide resolved
docs/source/daml2ts/index.rst Outdated Show resolved Hide resolved
docs/source/daml2ts/index.rst Outdated Show resolved Hide resolved
docs/source/daml2ts/index.rst Outdated Show resolved Hide resolved
Copy link
Contributor Author

@shayne-fletcher shayne-fletcher left a comment

Choose a reason for hiding this comment

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

Awesome, thank you so much!

I would recommend that once we have the different sections, we rearrange this a bit to move the more reference-style documentation somewhere to the end and start with a simple example of “Here is your daml model, invoke the codegen, this is how you create a template and call a choice”. That should get people started very quickly and then the reference documentation starts to become useful once you take a more detailed look.

Thanks for taking a look @cocreature ! Yes, this is just the first few steps feeling our way . There's obviously more to come (usage in particular) and there'll be rearrangement before it reaches its final form.

@shayne-fletcher shayne-fletcher force-pushed the language-support-docs branch 6 times, most recently from 287e445 to d6b8683 Compare January 24, 2020 22:27
@shayne-fletcher shayne-fletcher marked this pull request as ready for review January 24, 2020 22:28
@shayne-fletcher
Copy link
Contributor Author

@hurryabit have moved this out of draft status. Might I ask you to review please?

changelog_begin
changelog_end
@shayne-fletcher
Copy link
Contributor Author

To avoid conflicts while I get on with other work, forced to land this. If @hurryabit when, you're ready to review, please do so and we can iterate in a follow up PR!

@shayne-fletcher shayne-fletcher merged commit a56caa0 into master Jan 27, 2020
@shayne-fletcher shayne-fletcher deleted the language-support-docs branch January 27, 2020 17:25
Copy link
Contributor

@hurryabit hurryabit left a comment

Choose a reason for hiding this comment

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

Great start. Thanks a lot!

docs/source/daml2ts/index.rst Outdated Show resolved Hide resolved
docs/source/daml2ts/index.rst Show resolved Hide resolved
docs/source/daml2ts/index.rst Show resolved Hide resolved
docs/source/daml2ts/index.rst Show resolved Hide resolved
docs/source/daml2ts/index.rst Show resolved Hide resolved
docs/source/daml2ts/index.rst Show resolved Hide resolved
docs/source/daml2ts/index.rst Show resolved Hide resolved
docs/source/daml2ts/index.rst Show resolved Hide resolved
docs/source/daml2ts/index.rst Show resolved Hide resolved
docs/source/daml2ts/index.rst Show resolved Hide resolved
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