daml assistant should embed/serve SDK documentation
See original GitHub issueI think this could be done small-ish small steps that each add value, though some may be simple enough that they could be merged:
- Embed the HTML documentation in the SDK tarball (that may already be the case) and have a command from the assistant to spit it out, e.g.
daml docs 0.12.17 --pdf docs.pdf
anddaml docs 0.12.17 --html some-folder
. - Have the assistant itself be able to serve the SDK docs (embedded in the tarball) as a web server, as that’s the most convenient way to see HTML files:
daml serve-docs --port 6666
. If run from a project, pick up the SDK version from the daml.yml file, with cli flag to override.
See #1172 for adding a command to compile the docs of the current project.
In addition to documentation, we could also host a specialized Hoogle instance that includes all the loaded libraries.
Issue Analytics
- State:
- Created 4 years ago
- Comments:9 (6 by maintainers)
Top Results From Across the Web
Daml Assistant (daml) — Daml SDK 1.10.0 documentation
Daml Assistant ( daml )¶. daml is a command-line tool that does a lot of useful things related to the SDK. Using daml...
Read more >Release of Daml SDK 1.5.0 - Digital Asset Blog
Daml SDK 1.5.0 has been released on September 16th 2020. ... Daml Script is now fully integrated into the IDE and will supersede...
Read more >DAML SDK and Canton — Canton 0.20.0 documentation
In this tutorial, you will learn how to run the Create DAML App example on Canton. This guide (together with the DAML SDK...
Read more >digital-asset/daml: The Daml smart contract language - GitHub
Daml is an open-source smart contract language for building future-proof distributed applications on a safe, privacy-aware runtime. The SDK is a set of...
Read more >How to install the DAML SDK in a Ubuntu VM, which doesn't ...
However, the documentation for the new daml assistant is not on docs.daml.com yet. It will be shortly, but in the meantime you can...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Why not just point people at
docs.daml.com
? Isn’t that a much easier thing to do? What’s the disadvantage?Closing this in favor of #1172 due to low general enthusiasm for serving sdk docs locally. (We can always revisit this later.)