Skip to content

Commit

Permalink
Move the docs for the visualization to the experimental section (digi…
Browse files Browse the repository at this point in the history
  • Loading branch information
hurryabit authored Nov 19, 2019
1 parent c51ecd3 commit e82630d
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
1 change: 1 addition & 0 deletions docs/configs/pdf/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ Experimental features
daml-integration-kit/index
json-api/index
triggers/index
tools/visual

Support and updates
-------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ DAML SDK documentation

tools/assistant
tools/sandbox
tools/visual
tools/navigator/index
tools/codegen

Expand Down Expand Up @@ -99,6 +98,7 @@ DAML SDK documentation
migrate/index
json-api/index
DAML Triggers <triggers/index>
tools/visual

.. toctree::
:titlesonly:
Expand Down
8 changes: 4 additions & 4 deletions docs/source/tools/visual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You can generate visual graphs for the contracts in your DAML project. To do thi


Example: Visualizing the Quickstart project
*******************************************
===========================================

Here's an example visualization based on the :doc:`quickstart </getting-started/quickstart>`. You'll need to `install Graphviz <http://www.graphviz.org/download/>`_ to try this out.

Expand All @@ -32,15 +32,15 @@ Running the above should produce an image which looks something like this:


Visualizing DAML Contracts - Within IDE
#######################################
=======================================

You can generate visual graphs from VS Code IDE. Open the daml project in VS Code and use `command palette <https://code.visualstudio.com/docs/getstarted/tips-and-tricks#_command-palette/>`_. Should reveal a new window pane with dot image. Also visual generates only the currently open daml file and its imports.

Note: You will need to install the Graphviz/dot packages as mentioned above.


Visualizing DAML Contracts - Interactive Graphs
###############################################
===============================================

This does not require any packages installed. You can generate `D3 <https://d3js.org/>`_ graphs for the contracts in your DAML project. To do this

Expand All @@ -52,4 +52,4 @@ Running the above should produce an image which looks something like this:

.. image:: images/d3-visual.png
:width: 30%
:align: center
:align: center

0 comments on commit e82630d

Please sign in to comment.