Skip to content

Commit

Permalink
DAML/JavaScript: Make naming in docs consistent (digital-asset#5475)
Browse files Browse the repository at this point in the history
* DAML/JavaScript: Make naming in docs consistent

CHANGELOG_BEGIN
CHANGELOG_END

* Drop DAML/ prefix

CHANGELOG_BEGIN
CHANGELOG_END
  • Loading branch information
hurryabit authored Apr 7, 2020
1 parent af5b8e5 commit 26f073b
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 15 deletions.
Original file line number Diff line number Diff line change
@@ -1,18 +1,12 @@
.. Copyright (c) 2020 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved.
.. SPDX-License-Identifier: Apache-2.0
DAML to JavaScript code generation
##################################
JavaScript Code Generator
#########################

Code generation of DAML JavaScript bindings (with TypeScript typings)
=====================================================================
The command ``daml codegen js`` generates JavaScript (and TypeScript) that can be used in conjunction with the `JavaScript Client Libraries <../index>`_ for interacting with a DAML ledger via the `HTTP JSON API <../json-api/index.html>`_.

Introduction
------------

The command ``daml codegen js`` generates JavaScript for interacting with DAML via the `json-api <../json-api/index.html>`_ .

Inputs to the command are compiled DAML modules. Outputs are JavaScript packages and TypeScript typings for definitions modeling the DAML entities found in the DAML modules.
Inputs to the command are DAR files. Outputs are JavaScript packages with TypeScript typings containing metadata and types for all DAML packages included in the DAR files.

The generated packages use the library `@daml/types <https://github.com/digital-asset/daml/tree/master/language-support/ts/daml-types>`_.

Expand Down
10 changes: 6 additions & 4 deletions docs/source/app-dev/bindings-ts/index.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
.. Copyright (c) 2020 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved.
.. SPDX-License-Identifier: Apache-2.0
TypeScript bindings
###################
JavaScript Client Libraries
###########################

.. _typescript:

The DAML TypeScript bindings are the recommended way to build a frontend for a DAML application. We
provide an integration for the `React <https://reactjs.org>`_ framework with the `@daml/react
The JavaScript Client Libraries are the recommended way to build a frontend for a DAML application.
The `JavaScript Code Generator <daml2js>`_ can automatically generate JavaScript containing metadata about DAML packages that is required to use these libraries.
We provide an integration for the `React <https://reactjs.org>`_ framework with the `@daml/react
<daml-react/index.html>`_ library. However, you can choose any JavaScript/TypeScript based framework
and use the `@daml/ledger <daml-ledger/index.html>`_ library directly to connect and interact with a
DAML ledger via its :ref:`HTTP JSON API <json-api>`.
Expand All @@ -19,6 +20,7 @@ and `@daml/ledger <daml-ledger/index.html>`_ libraries.
.. toctree::
:hidden:

daml2js
daml-react
daml-ledger
daml-types
1 change: 0 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ DAML SDK documentation
:caption: Building applications

app-dev/app-arch
daml2js/index
app-dev/bindings-ts/index
json-api/index
DAML Script <daml-script/index>
Expand Down

0 comments on commit 26f073b

Please sign in to comment.