corda/docs/source/index.rst

Welcome to the Corda documentation!
===================================

.. warning:: This build of the docs is from the "|version|" branch, not a milestone release. It may not reflect the
   current state of the code. `Read the docs for M6 <https://docs.corda.net/releases/release-M6.0/>`_.

This is the developer guide for Corda, a proposed architecture for distributed ledgers. Here are the sources
of documentation you may find useful, from highest level to lowest:

1. The `Introductory white paper`_ describes the motivating vision and background of the project. It is the kind
   of document your boss should read. It describes why the project exists and briefly compares it to alternative
   systems on the market.
2. The `Technical white paper`_ describes the entire intended design from beginning to end. It is the kind of
   document that you should read, or at least, read parts of. Note that because the technical white paper
   describes the intended end state, it does not always align with the implementation.
3. This user guide. It describes *how* to use the system to write apps, as currently implemented. It assumes
   you already have read the relevant sections of the technology white paper and now wish to learn how to use it.
4. The `API docs`_.

.. _`Introductory white paper`: _static/corda-introductory-whitepaper.pdf
.. _`Technical white paper`: _static/corda-technical-whitepaper.pdf
.. _`API docs`: api/index.html

Read on to learn:

.. toctree::
   :maxdepth: 2
   :caption: Getting started

   inthebox
   getting-set-up
   getting-set-up-fault-finding
   running-the-demos
   CLI-vs-IDE

.. toctree::
   :maxdepth: 2
   :caption: Key concepts

   data-model
   transaction-data-types
   merkle-trees
   consensus
   clauses

.. toctree::
   :maxdepth: 2
   :caption: CorDapps

   creating-a-cordapp
   tutorial-cordapp

.. toctree::
   :maxdepth: 2
   :caption: The Corda node

   clientrpc
   messaging
   persistence
   node-administration
   corda-configuration-file
   corda-plugins
   node-services
   node-explorer
   permissioning

.. toctree::
   :maxdepth: 2
   :caption: Tutorials

   tutorial-contract
   tutorial-contract-clauses
   tutorial-test-dsl
   tutorial-integration-testing
   tutorial-clientrpc-api
   tutorial-building-transactions
   flow-state-machines
   flow-testing
   running-a-notary
   using-a-notary
   oracles
   tutorial-attachments
   event-scheduling

.. toctree::
   :maxdepth: 2
   :caption: Other

   network-simulator
   initial-margin-agreement

.. toctree::
   :maxdepth: 2
   :caption: Component library

   contract-catalogue
   contract-irs

.. toctree::
   :maxdepth: 2
   :caption: Appendix

   loadtesting
   setting-up-a-corda-network
   secure-coding-guidelines
   release-process
   release-notes
   codestyle
   building-the-docs

.. toctree::
   :maxdepth: 2
   :caption: Glossary

   glossary
Changed SDK tutorial based on latest repo changes and some feedback. Addressed some review comments. Latest changes to SDK tutorial based on review comments. Corda SDK -> CorDapp Template Addressed review comments + added some new sections. Added pic of run config drop down menu. Added a couple of additional sections. Refactored the 'how to make a cordapp' how to a separate docs pages and stubbed it out for comments. Added index.rst Additional changes based on feedback. Addressed review comments. Removed spurious buuildinfo file. Minor changes based on richard's comments. Still waiting on resolution of dev experience preference. Changed milestone release workflow. Users now should checkout a specific tag. 2016-11-17 18:31:17 +00:00			`Welcome to the Corda documentation!`
			`===================================`
Introduce documentation of the current prototype with a contract programming tutorial (incomplete), using the Sphinx docs engine. Actual generated HTML will follow in the next commit. 2015-11-25 13:27:07 +00:00
Making the warning make sense for branches that aren't master 2016-12-06 10:12:57 +00:00			`.. warning:: This build of the docs is from the "\|version\|" branch, not a milestone release. It may not reflect the`
Docs: point to M6 docs from master branch warning 2016-11-29 20:49:14 +00:00			current state of the code. `Read the docs for M6 <https://docs.corda.net/releases/release-M6.0/>`_.
Docsite: add a warning to the index page about the docsite being for master, and update the release process doc to remind the release master to remove it on the branch. 2016-08-30 10:53:34 +00:00
Release notes for M5 Add a snapshot of the tech whitepaper. Misc doc fixes. Change README to prepare for the open source release. 2016-11-04 13:10:27 +00:00			`This is the developer guide for Corda, a proposed architecture for distributed ledgers. Here are the sources`
			`of documentation you may find useful, from highest level to lowest:`
Added Corda Whitepaper 2016-08-11 12:57:41 +00:00
Release notes for M5 Add a snapshot of the tech whitepaper. Misc doc fixes. Change README to prepare for the open source release. 2016-11-04 13:10:27 +00:00			1. The `Introductory white paper`_ describes the motivating vision and background of the project. It is the kind
			`of document your boss should read. It describes why the project exists and briefly compares it to alternative`
			`systems on the market.`
Publish technical white paper to the docsite 2016-11-16 13:57:14 +00:00			2. The `Technical white paper`_ describes the entire intended design from beginning to end. It is the kind of
			`document that you should read, or at least, read parts of. Note that because the technical white paper`
			`describes the intended end state, it does not always align with the implementation.`
			`3. This user guide. It describes how to use the system to write apps, as currently implemented. It assumes`
			`you already have read the relevant sections of the technology white paper and now wish to learn how to use it.`
			4. The `API docs`_.
Introduce documentation of the current prototype with a contract programming tutorial (incomplete), using the Sphinx docs engine. Actual generated HTML will follow in the next commit. 2015-11-25 13:27:07 +00:00
Release notes for M5 Add a snapshot of the tech whitepaper. Misc doc fixes. Change README to prepare for the open source release. 2016-11-04 13:10:27 +00:00			.. _`Introductory white paper`: _static/corda-introductory-whitepaper.pdf
			.. _`Technical white paper`: _static/corda-technical-whitepaper.pdf
			.. _`API docs`: api/index.html
Docs: add link from docsite to api docs 2016-03-08 17:32:13 +00:00
Introduce documentation of the current prototype with a contract programming tutorial (incomplete), using the Sphinx docs engine. Actual generated HTML will follow in the next commit. 2015-11-25 13:27:07 +00:00			`Read on to learn:`

			`.. toctree::`
			`:maxdepth: 2`
Doc index structure change 2016-11-18 12:17:32 +00:00			`:caption: Getting started`
Introduce documentation of the current prototype with a contract programming tutorial (incomplete), using the Sphinx docs engine. Actual generated HTML will follow in the next commit. 2015-11-25 13:27:07 +00:00
			`inthebox`
			`getting-set-up`
Minor docs tweaks: * Removed "where-to-start" as it was old and will be replaced with the developing CorDapps page. * Re-arranged the index page. * Put the getting started fault finding page on the index (it wasn't referenced before). * Deleted the "building cordapps" page as requested by Mike. 2016-11-29 18:31:28 +00:00			`getting-set-up-fault-finding`
Doc index structure change 2016-11-18 12:17:32 +00:00			`running-the-demos`
Adding a CLI / IDE page 2016-11-28 11:44:03 +00:00			`CLI-vs-IDE`
Doc index structure change 2016-11-18 12:17:32 +00:00
			`.. toctree::`
			`:maxdepth: 2`
			`:caption: Key concepts`

Docs: regen HTML + reorganise left hand menu a bit. 2015-12-22 15:15:38 +00:00			`data-model`
Add documentation of transaction data types 2016-06-07 16:47:16 +00:00			`transaction-data-types`
Add transaction tear-offs documentation. 2016-11-08 17:45:28 +00:00			`merkle-trees`
Docs: misc markup fixes and adjust an out of date paragraph about oracles. 2016-05-17 17:40:53 +00:00			`consensus`
Minor docs tweaks: * Removed "where-to-start" as it was old and will be replaced with the developing CorDapps page. * Re-arranged the index page. * Put the getting started fault finding page on the index (it wasn't referenced before). * Deleted the "building cordapps" page as requested by Mike. 2016-11-29 18:31:28 +00:00			`clauses`

			`.. toctree::`
			`:maxdepth: 2`
			`:caption: CorDapps`

			`creating-a-cordapp`
			`tutorial-cordapp`
Doc index structure change 2016-11-18 12:17:32 +00:00
			`.. toctree::`
			`:maxdepth: 2`
			`:caption: The Corda node`

			`clientrpc`
Messaging: add docs on the messaging and protocol state machine systems. 2015-12-14 17:22:21 +00:00			`messaging`
Hibernate ORM implementation for states. 2016-09-27 14:17:27 +00:00			`persistence`
Add a section to the docsite about node administration, cover attachment upload/download. 2016-03-04 15:15:32 +00:00			`node-administration`
Cleaning up doc headers to be consistent wrt casing 2016-11-25 14:29:13 +00:00			`corda-configuration-file`
Document on plugin loading framework and a tiny tweak on logging. Word wrap document. Change protocol to flow. Try to improve plugin discussion based on PR comments. add comma 2016-11-22 11:57:11 +00:00			`corda-plugins`
Rather brief description of every service implemented in the node project. Take on fixes from PR. Change protocol to flow. Update for Shams's comments Fix typos 2016-11-21 18:14:18 +00:00			`node-services`
permissioning doc 2016-11-24 16:38:40 +00:00			`node-explorer`
			`permissioning`
# This is a combination of 2 commits. # The first commit's message is: Release notes for M2 # The 2nd commit message will be skipped: # Docs: Address release notes review comments, re-arrange the sidebar and mention the new TF code that has been added. 2016-07-28 10:46:12 +00:00
Docs: regen HTML + reorganise left hand menu a bit. 2015-12-22 15:15:38 +00:00			`.. toctree::`
			`:maxdepth: 2`
			`:caption: Tutorials`

Docs: misc markup fixes and adjust an out of date paragraph about oracles. 2016-05-17 17:40:53 +00:00			`tutorial-contract`
Add documentation on contract clauses 2016-07-12 09:24:11 +00:00			`tutorial-contract-clauses`
docs: Add tutorial on the test DSL 2016-07-08 17:33:48 +00:00			`tutorial-test-dsl`
docs: Add integration test tutorial 2016-11-25 15:26:00 +00:00			`tutorial-integration-testing`
docs: add docs/source/example-code module, tutorial on the Client RPC API 2016-10-04 12:56:31 +00:00			`tutorial-clientrpc-api`
Created some examples to include in tutorial on building transactions. Complete the transaction building doc with code fragments. Fix gradle build Handle PR comments Put back in missing main class line Couple of minor improvements from PR 2016-11-28 13:39:34 +00:00			`tutorial-building-transactions`
Fix bad merge on index.rst 2016-11-24 08:21:21 +00:00			`flow-state-machines`
Fix up and improve some docs 2016-11-21 17:11:51 +00:00			`flow-testing`
Added tutorials on how to use & run a notary. 2016-11-25 15:11:19 +00:00			`running-a-notary`
			`using-a-notary`
Docs: remove roadmap, add a new doc page on oracles. 2016-03-11 12:42:11 +00:00			`oracles`
Add attachement demo and documentation Add a demo of attachments on transactions as a worked example for others to use, along with documentation on how to run it, and how it functions. 2016-09-23 13:41:29 +00:00			`tutorial-attachments`
Event scheduling and docs for event scheduling 2016-05-24 09:03:29 +00:00			`event-scheduling`
Docs: regen HTML + reorganise left hand menu a bit. 2015-12-22 15:15:38 +00:00
Add a client library that provides an RPC mechanism for talking to the Corda node. The RPC mechanism uses message queues and is essentially conventional except for the fact that it supports marshalling observables. An observable encapsulates a stream of ongoing events, and server-side observables sent to the client are automatically bound to message queues and managed by Artemis. 2016-08-26 13:31:17 +00:00			`.. toctree::`
			`:maxdepth: 2`
Doc index structure change 2016-11-18 12:17:32 +00:00			`:caption: Other`
Add a client library that provides an RPC mechanism for talking to the Corda node. The RPC mechanism uses message queues and is essentially conventional except for the fact that it supports marshalling observables. An observable encapsulates a stream of ongoing events, and server-side observables sent to the client are automatically bound to message queues and managed by Artemis. 2016-08-26 13:31:17 +00:00
Doc index structure change 2016-11-18 12:17:32 +00:00			`network-simulator`
Changes from a doc review that were omitted in first PR, also changes from corda=samples repo 2016-11-14 18:12:39 +00:00			`initial-margin-agreement`
Add a client library that provides an RPC mechanism for talking to the Corda node. The RPC mechanism uses message queues and is essentially conventional except for the fact that it supports marshalling observables. An observable encapsulates a stream of ongoing events, and server-side observables sent to the client are automatically bound to message queues and managed by Artemis. 2016-08-26 13:31:17 +00:00
			`.. toctree::`
			`:maxdepth: 2`
Doc index structure change 2016-11-18 12:17:32 +00:00			`:caption: Component library`
Add a client library that provides an RPC mechanism for talking to the Corda node. The RPC mechanism uses message queues and is essentially conventional except for the fact that it supports marshalling observables. An observable encapsulates a stream of ongoing events, and server-side observables sent to the client are automatically bound to message queues and managed by Artemis. 2016-08-26 13:31:17 +00:00
Doc index structure change 2016-11-18 12:17:32 +00:00			`contract-catalogue`
			`contract-irs`
Add a client library that provides an RPC mechanism for talking to the Corda node. The RPC mechanism uses message queues and is essentially conventional except for the fact that it supports marshalling observables. An observable encapsulates a stream of ongoing events, and server-side observables sent to the client are automatically bound to message queues and managed by Artemis. 2016-08-26 13:31:17 +00:00
Docs: regen HTML + reorganise left hand menu a bit. 2015-12-22 15:15:38 +00:00			`.. toctree::`
			`:maxdepth: 2`
			`:caption: Appendix`

Docs: add load testing page to the appendix 2016-11-18 12:16:06 +00:00			`loadtesting`
docs: Add setting-up-a-corda-network to index.html 2016-11-28 11:58:14 +00:00			`setting-up-a-corda-network`
Minor: docs, fix header level in cordapp page. 2016-10-12 10:54:23 +00:00			`secure-coding-guidelines`
Add a page that briefly describes the proposed release process. 2016-05-10 16:44:41 +00:00			`release-process`
Docsite: added a release notes page 2016-05-24 11:26:17 +00:00			`release-notes`
Add a coding style guide. 2016-01-27 15:01:33 +00:00			`codestyle`
Add tutorial on building documentation 2016-04-27 17:37:27 +00:00			`building-the-docs`
Doc index structure change 2016-11-18 12:17:32 +00:00
			`.. toctree::`
			`:maxdepth: 2`
			`:caption: Glossary`

Adding glossary 2016-11-21 16:00:22 +00:00			`glossary`