digital-asset/daml
1
1
Fork 0
mirror of https://github.com/digital-asset/daml.git synced 2024-11-10 10:46:11 +03:00
Code Issues Projects Releases Wiki Activity
ab93435442
daml/docs/source/index.rst

113 lines
1.9 KiB
ReStructuredText
Raw Normal View History

replace DAML Authors with DA in copyright headers (#5228) Change requested by Manoj. CHANGELOG_BEGIN CHANGELOG_END
2020-03-27 03:26:10 +03:00
.. Copyright (c) 2020 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved.
open-sourcing daml
2019-04-04 11:33:38 +03:00
.. SPDX-License-Identifier: Apache-2.0
DAML SDK documentation
######################
.. toctree::
:titlesonly:
:maxdepth: 2
:hidden:
self
.. toctree::
:titlesonly:
:maxdepth: 2
:hidden:
Improve docs flow (#1101) * Improve docs flow * Move integration kit as Simon requested * Update daml-foundations/daml-ghc/base-rst-prefix.rst Co-Authored-By: Martin Huschenbett <martin.huschenbett@posteo.me>
2019-05-13 21:24:18 +03:00
:caption: Getting started
open-sourcing daml
2019-04-04 11:33:38 +03:00
Installing the SDK <getting-started/installation>
Replace quickstart with new getting started guide (#5392) * Move quickstart to java bindings section * Change title of quickstart to Getting Started with ... * Move GSG to Getting Started (and rename in index) * Rewrite a bunch of references to quickstart * Update reference and give more specific name changelog_begin - [Docs] Replace IOU quickstart with full stack Getting Started Guide changelog_end * Replace daml-ledger link * Use getting started guide in redirects
2020-04-03 18:44:19 +03:00
Building Your App <getting-started/index>
Relabel "Experimental" to "Early Access" and reorganise pages (#5411) CHANGELOG_BEGIN - Move daml2ts, bindings-ts and JSON API out of experimental section in docs - Rename Experimental to Early Access in docs and assistant - Reorganise the docs a little bit to de-emphasise the Ledger API CHANGELOG_END
2020-04-03 17:29:22 +03:00
getting-started/testing
open-sourcing daml
2019-04-04 11:33:38 +03:00
.. toctree::
:titlesonly:
:maxdepth: 2
:hidden:
Improve docs flow (#1101) * Improve docs flow * Move integration kit as Simon requested * Update daml-foundations/daml-ghc/base-rst-prefix.rst Co-Authored-By: Martin Huschenbett <martin.huschenbett@posteo.me>
2019-05-13 21:24:18 +03:00
:caption: Writing DAML
open-sourcing daml
2019-04-04 11:33:38 +03:00
Daml intro (#1717) * DAML Intro Sections 1 - 7 * Apply suggestions from code review Co-Authored-By: Beth Aitman <bethaitman@users.noreply.github.com> * Address Beth's comments * Rebase and fix release notes * Add suggestions for Haskell reading
2019-06-18 12:56:06 +03:00
daml/intro/0_Intro.rst
open-sourcing daml
2019-04-04 11:33:38 +03:00
daml/reference/index
Split standard library docs up one page per module. (#5636) * One module per page in stdlib docs. changelog_begin - [DAML Docs] The standard library docs have been split up per module. changelog_end * Adjust stdlib annotations * Update compiler/damlc/daml-stdlib-src/DA/Generics.daml Co-Authored-By: Moritz Kiefer <moritz.kiefer@purelyfunctional.org> * Update compiler/damlc/base-rst-index-template.rst Co-Authored-By: Moritz Kiefer <moritz.kiefer@purelyfunctional.org> * Move to daml/stdlib * Update daml-doc tests * Remove the Module prefix in the index/toctree Co-authored-by: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>
2020-04-22 15:23:46 +03:00
daml/stdlib/index
open-sourcing daml
2019-04-04 11:33:38 +03:00
daml/daml-studio
daml/testing-scenarios
daml/troubleshooting
daml/good-daml
.. toctree::
:titlesonly:
:maxdepth: 2
:hidden:
Improve docs flow (#1101) * Improve docs flow * Move integration kit as Simon requested * Update daml-foundations/daml-ghc/base-rst-prefix.rst Co-Authored-By: Martin Huschenbett <martin.huschenbett@posteo.me>
2019-05-13 21:24:18 +03:00
:caption: Building applications
open-sourcing daml
2019-04-04 11:33:38 +03:00
docs: new recommend path architecture documentation (#4795) CHANGELOG_BEGIN CHANGELOG_END
2020-03-09 14:15:37 +03:00
app-dev/app-arch
lanugage:docs: include generated docs on docs.daml.com (#4924) This includes the generated docs for the typescipt libraries daml-react, daml-ledger and daml-types in the documentation presented on docs.daml.com. Next step is to create better readmes in this libraries. CHANGELOG_BEGIN CHANGELOG_END
2020-03-10 20:46:54 +03:00
app-dev/bindings-ts/index
Freeze JSON API v1 (#5387) * move JSON API doc to "Building applications" * stop describing JSON API as experimental; limit to calling WebSocket endpoints alpha * remove "(experimental)" from daml json-api docstring * add changelog CHANGELOG_BEGIN - [JSON API] First stable version of the ``/v1`` endpoints, with the exception of the WebSocket endpoints, which remain in alpha. See `issue #4458 <https://github.com/digital-asset/daml/issues/4458>`_. CHANGELOG_END * move json-api in PDF ToC, adapting to #5411 c496e2bf05 - pointed out by @cocreature; thanks
2020-04-03 20:58:17 +03:00
json-api/index
docs: new recommend path architecture documentation (#4795) CHANGELOG_BEGIN CHANGELOG_END
2020-03-09 14:15:37 +03:00
DAML Script <daml-script/index>
upgrade/index
Relabel "Experimental" to "Early Access" and reorganise pages (#5411) CHANGELOG_BEGIN - Move daml2ts, bindings-ts and JSON API out of experimental section in docs - Rename Experimental to Early Access in docs and assistant - Reorganise the docs a little bit to de-emphasise the Ledger API CHANGELOG_END
2020-04-03 17:29:22 +03:00
app-dev/authentication
app-dev/ledger-api
docs: new recommend path architecture documentation (#4795) CHANGELOG_BEGIN CHANGELOG_END
2020-03-09 14:15:37 +03:00
.. toctree::
:titlesonly:
:maxdepth: 2
:hidden:
:caption: Deploying to DAML ledgers
deploy/index
deploy/generic_ledger
deploy/ledger-topologies
Custom bindings doc + iou-no-codegen scala example (#1569) * Custom bindings doc + iou-no-codegen scala example * Fixing formatting * Review suggestion Co-Authored-By: Stephen Compall <scompall@nocandysw.com> * Adding bazel build for `language-support/scala/examples/iou-no-codegen` * Review suggestions * Final touches + addressing review comments * Adding notes about codegen alternatives * Removing detectedOs lazy val
2019-06-12 16:26:54 +03:00
open-sourcing daml
2019-04-04 11:33:38 +03:00
.. toctree::
:titlesonly:
:maxdepth: 2
:hidden:
Improve docs flow (#1101) * Improve docs flow * Move integration kit as Simon requested * Update daml-foundations/daml-ghc/base-rst-prefix.rst Co-Authored-By: Martin Huschenbett <martin.huschenbett@posteo.me>
2019-05-13 21:24:18 +03:00
:caption: SDK tools
open-sourcing daml
2019-04-04 11:33:38 +03:00
tools/assistant
tools/sandbox
tools/navigator/index
DAML assistant codegen command (#2800) * DAML assistant codegen command, codegen config reader and docs
2019-09-12 21:23:49 +03:00
tools/codegen
open-sourcing daml
2019-04-04 11:33:38 +03:00
.. toctree::
:titlesonly:
:maxdepth: 2
:hidden:
Improve docs flow (#1101) * Improve docs flow * Move integration kit as Simon requested * Update daml-foundations/daml-ghc/base-rst-prefix.rst Co-Authored-By: Martin Huschenbett <martin.huschenbett@posteo.me>
2019-05-13 21:24:18 +03:00
:caption: Background concepts
open-sourcing daml
2019-04-04 11:33:38 +03:00
Glossary for SDK (#1557) * Fix formatting issue * Add outline of glossary * Actually add glossary Starting stuff Interim stage Add more glossary details * Finishing off detail * Link everything up
2019-06-12 17:38:50 +03:00
concepts/glossary
open-sourcing daml
2019-04-04 11:33:38 +03:00
concepts/ledger-model/index
Identity and package management (#2532) * Identity and package management * Apply suggestions from code review Co-Authored-By: Bernhard Elsner <40762178+bame-da@users.noreply.github.com> * Bernhard's comments * Simon's comments * Update license * Oh noes - I broked teh linkz!
2019-08-19 20:09:29 +03:00
concepts/identity-and-package-management
open-sourcing daml
2019-04-04 11:33:38 +03:00
.. toctree::
:titlesonly:
:maxdepth: 2
:hidden:
:caption: Examples
examples/examples
.. toctree::
:titlesonly:
:maxdepth: 2
:hidden:
Relabel "Experimental" to "Early Access" and reorganise pages (#5411) CHANGELOG_BEGIN - Move daml2ts, bindings-ts and JSON API out of experimental section in docs - Rename Experimental to Early Access in docs and assistant - Reorganise the docs a little bit to de-emphasise the Ledger API CHANGELOG_END
2020-04-03 17:29:22 +03:00
:caption: Early Access Features
open-sourcing daml
2019-04-04 11:33:38 +03:00
Relabel "Experimental" to "Early Access" and reorganise pages (#5411) CHANGELOG_BEGIN - Move daml2ts, bindings-ts and JSON API out of experimental section in docs - Rename Experimental to Early Access in docs and assistant - Reorganise the docs a little bit to de-emphasise the Ledger API CHANGELOG_END
2020-04-03 17:29:22 +03:00
tools/navigator/console
tools/extractor
Bring back daml integration kit docs (#3292) * Bring back daml integration kit docs This just revives the documentation, without updating it yet. * Updated URLs and remvoe references to the IndexService * Add release note for revival of integration kit docs * Update unreleased.rst * update release notes
2019-10-30 20:15:58 +03:00
daml-integration-kit/index
Relabel "Experimental" to "Early Access" and reorganise pages (#5411) CHANGELOG_BEGIN - Move daml2ts, bindings-ts and JSON API out of experimental section in docs - Rename Experimental to Early Access in docs and assistant - Reorganise the docs a little bit to de-emphasise the Ledger API CHANGELOG_END
2020-04-03 17:29:22 +03:00
triggers/index
daml-repl/index
Move the docs for the visualization to the experimental section (#3531)
2019-11-19 19:40:50 +03:00
tools/visual
open-sourcing daml
2019-04-04 11:33:38 +03:00
.. toctree::
:titlesonly:
:maxdepth: 2
:hidden:
Improve docs flow (#1101) * Improve docs flow * Move integration kit as Simon requested * Update daml-foundations/daml-ghc/base-rst-prefix.rst Co-Authored-By: Martin Huschenbett <martin.huschenbett@posteo.me>
2019-05-13 21:24:18 +03:00
:caption: Support and updates
open-sourcing daml
2019-04-04 11:33:38 +03:00
support/support
support/release-notes
Roadmap <support/roadmap>
Reference in New Issue Copy Permalink