diff --git a/docs/source/building-a-cordapp-index.rst b/docs/source/building-a-cordapp-index.rst index b3b4bd8eb6..a1373f9849 100644 --- a/docs/source/building-a-cordapp-index.rst +++ b/docs/source/building-a-cordapp-index.rst @@ -10,4 +10,5 @@ CorDapps building-against-master corda-api flow-cookbook - cheat-sheet \ No newline at end of file + cheat-sheet + building-a-cordapp-samples diff --git a/docs/source/building-a-cordapp-samples.rst b/docs/source/building-a-cordapp-samples.rst new file mode 100644 index 0000000000..40affe1a26 --- /dev/null +++ b/docs/source/building-a-cordapp-samples.rst @@ -0,0 +1,21 @@ +CorDapp samples +=============== + +There are two distinct sets of samples provided with Corda, one introducing new developers to how to write CorDapps, and +more complex worked examples of how solutions to a number of common designs could be implemented in a CorDapp. +The former can be found on `the Corda website `_. In particular, new developers +should start with the :doc:`example CorDapp `. + +The advanced samples are contained within the `samples/` folder of the Corda repository. The most generally useful of +these samples are: + +1. The `trader-demo`, which shows a delivery-vs-payment atomic swap of commercial paper for cash +2. The `attachment-demo`, which demonstrates uploading attachments to nodes +3. The `bank-of-corda-demo`, which shows a node acting as an issuer of assets (the Bank of Corda) while remote client + applications request issuance of some cash on behalf of a node called Big Corporation + +Documentation on running the samples can be found inside the sample directories themselves, in the `README.md` file. + +.. note:: If you would like to see flow activity on the nodes type in the node terminal ``flow watch``. + +Please report any bugs with the samples on `GitHub `_. diff --git a/docs/source/quickstart-index.rst b/docs/source/quickstart-index.rst index a42b469e95..02e9045ac9 100644 --- a/docs/source/quickstart-index.rst +++ b/docs/source/quickstart-index.rst @@ -7,4 +7,5 @@ Quickstart getting-set-up tutorial-cordapp Sample CorDapps + building-against-master CLI-vs-IDE \ No newline at end of file diff --git a/docs/source/running-the-demos.rst b/docs/source/running-the-demos.rst deleted file mode 100644 index e69de29bb2..0000000000