f8c0a35940
* rewrite trigger docs to follow gsg Per #10419 point 4, I've rewritten the Triggers section to build upon the Getting Started Guide instead of inventing its own example. Compared to #10395, this has a lot more explanations as this page must now serve the dual purpose of being a possible "next step" from the GSG and being the main reference page for triggers. It's also lost the "next steps" section, which I think is a bit of a shame, but it doesn't really make sense here. There's also no easy way for people not interested in the GSG to follow along; should we expose the "completed GSG" as a tempate? CHANGELOG_BEGIN CHANGELOG_END * keep copy-trigger as a template * fix copy-trigger project name * make up gsg-trigger template * remove awkward sentence, fix existing typo * update code to use when{,Some} * add to * swap emitCommands and getCommandsInFlight * typo * insist on state-correction perspective * fix copy-trigger tests * add back copy-trigger to whitelist * add gsg-trigger to whitelist |
||
|---|---|---|
| .. | ||
| configs | ||
| scripts | ||
| source | ||
| theme | ||
| .gitignore | ||
| BUILD.bazel | ||
| daml-intro-7.yaml | ||
| error.html | ||
| README.md | ||
| redirect_template.html | ||
| redirects.map | ||
Daml Documentation
This directory contains all of the documentation that gets published to docs.daml.com.
Writing documentation
The docs are written in reStructuredText, built using Sphinx.
To edit documentation:
-
Same as code: find the file, edit it on a branch, make a PR.
-
For new files, best to copy existing ones, to get the formatting right.
Don't forget you need to add your file to the
toctreein/docs/source/index.rstand/docs/configs/pdf/index.rst. -
Make sure you preview before you push.
-
Don't insert line-breaks inside inline literals. Building preview will treat this as an error.
Generated documentation
Not all of our docs are in rst files: some get generated. They are:
- the ledger API proto docs
- the Daml standard library reference
- the Java bindings reference
To edit those docs, edit the content inside the code source.
Previewing
To preview the full docs, as deployed to docs.daml.com, run scripts/preview.sh.
To live-preview the docs, run scripts/live-preview.sh. The script accepts two flags:
--pdfincludes the PDF documentation--genincludes the generated documentation
Note that neither PDF, nor generated docs will benefit from live updates. To update generated docs or PDF docs, quit the preview script with CTRL+C and start it again.
Style conventions
For terminology and other style questions, follow the main DA documentation style guide.
A few pieces of RST guidance:
If you’re not familiar, it’s really worth reading the primer for the basic syntax (emphasis, code text, lists, tables, images, comments, etc).
-
Keep paragraphs all on the same line (no newlines/line breaks).
-
Heading underlines in this hierarchical order:
###### ****** ====== ------ ^^^^^^ """""" -
For internal links, use the
docdirective where you can. -
For bullet points (unordered lists), use
-(dashes). -
For code blocks, use the
literalincludedirective if you can: it's best to source code from files that we test whether they compile.
How the docs get built
The docs get built as part of the main daml repo CI, to make sure we don't break any links or do anything else that would cause Sphinx warnings.
Publishing docs
Documentation is published automatically whenever a release is made public on Github. Note that there is a delay so you might have to wait up to an hour until the docs are published after making a release public.
Testing code in docs
TBD