-
Notifications
You must be signed in to change notification settings - Fork 205
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
Conversation
9fc27b5
to
e5a1dee
Compare
There was a problem hiding this 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.
There was a problem hiding this 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.
There was a problem hiding this 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.
287e445
to
d6b8683
Compare
@hurryabit have moved this out of draft status. Might I ask you to review please? |
d6b8683
to
21ddddf
Compare
changelog_begin changelog_end
21ddddf
to
0ee7fd5
Compare
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! |
There was a problem hiding this 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!
Add user facing documentation explaining daml2ts.