diff --git a/docs/source/building-a-cordapp-index.rst b/docs/source/building-a-cordapp-index.rst index 12466338ee..a5ea4e9bfe 100644 --- a/docs/source/building-a-cordapp-index.rst +++ b/docs/source/building-a-cordapp-index.rst @@ -7,5 +7,6 @@ Building a CorDapp cordapp-overview writing-cordapps cordapp-build-systems + corda-api flow-cookbook cheat-sheet \ No newline at end of file diff --git a/docs/source/corda-modules.rst b/docs/source/corda-api.rst similarity index 97% rename from docs/source/corda-modules.rst rename to docs/source/corda-api.rst index 0307db092c..57863be4b7 100644 --- a/docs/source/corda-modules.rst +++ b/docs/source/corda-api.rst @@ -1,7 +1,7 @@ -Corda modules -============= +Corda API +========= -This section describes the APIs that are available for the development of CorDapps: +The following are the core APIs that are used in the development of CorDapps: .. toctree:: :maxdepth: 1 diff --git a/docs/source/getting-set-up.rst b/docs/source/getting-set-up.rst index 1fbe7060b3..f6ce762df1 100644 --- a/docs/source/getting-set-up.rst +++ b/docs/source/getting-set-up.rst @@ -169,7 +169,7 @@ The best way to check that everything is working fine is by taking a deeper look Next, you should read through :doc:`Corda Key Concepts ` to understand how Corda works. By then, you'll be ready to start writing your own CorDapps. Learn how to do this in the -:doc:`Hello, World tutorial `. You may want to refer to the :doc:`Modules documentation ` along the +:doc:`Hello, World tutorial `. You may want to refer to the :doc:`API documentation ` along the way. If you encounter any issues, please see the :doc:`troubleshooting` page, or get in touch with us on the diff --git a/docs/source/hello-world-running.rst b/docs/source/hello-world-running.rst index 1bfc2be2df..ae91fe0907 100644 --- a/docs/source/hello-world-running.rst +++ b/docs/source/hello-world-running.rst @@ -117,15 +117,9 @@ commands. We want to create an IOU of 100 with PartyB. We start the ``IOUFlow`` by typing: -.. container:: codeset +.. code:: bash - .. code-block:: java - - start IOUFlow arg0: 99, arg1: "O=PartyB,L=New York,C=US" - - .. code-block:: kotlin - - start IOUFlow iouValue: 99, otherParty: "O=PartyB,L=New York,C=US" + start IOUFlow iouValue: 99, otherParty: "O=PartyB,L=New York,C=US" PartyA and PartyB will automatically agree an IOU. If the flow worked, it should have led to the recording of a new IOU in the vaults of both PartyA and PartyB. diff --git a/docs/source/other-index.rst b/docs/source/other-index.rst index 539608be94..7f6fa6ef66 100644 --- a/docs/source/other-index.rst +++ b/docs/source/other-index.rst @@ -7,6 +7,5 @@ Other json secure-coding-guidelines corda-repo-layout - corda-modules building-the-docs codestyle \ No newline at end of file diff --git a/docs/source/release-notes.rst b/docs/source/release-notes.rst index 3552fc329e..72baf8cd6f 100644 --- a/docs/source/release-notes.rst +++ b/docs/source/release-notes.rst @@ -32,7 +32,7 @@ Our extensive testing frameworks will continue to evolve alongside future Corda we have introduced a new test node driver module to encapsulate all test functionality in support of building standalone node integration tests using our DSL driver. -Please read :doc:`corda-modules` for complete details. +Please read :doc:`corda-api` for complete details. .. note:: it may be necessary to recompile applications against future versions of the API until we begin offering `ABI (Application Binary Interface) `_ stability as well.