corda/docs/source/index.rst

Welcome to the Corda repository!
================================

.. warning:: This build of the docs is from the *master branch*, not a milestone release. It may not reflect the
   current state of the code.

This documentation describes Corda, a proposed architecture for distributed ledgers, the vision for which is outlined in the `Corda Introductory Whitepaper`_.

.. _`Corda Introductory Whitepaper`: _static/corda-introductory-whitepaper.pdf

The goal of this prototype is to explore fundamentally better designs for distributed ledgers than what presently exists
on the market, tailor made for the needs of the financial industry. We are attempting to prove or disprove the
following hypothesis:

The combination of

* An upgraded state transition model
* Industry standard, production quality virtual machines and languages
* An advanced orchestration framework
* Limited data propagation
* Conflict resolution without proof of work or blocks

is sufficiently powerful to justify the creation of a new platform implementation.

Read on to learn:

.. toctree::
   :maxdepth: 2
   :caption: Overview

   inthebox
   getting-set-up
   data-model
   transaction-data-types
   consensus
   messaging
   persistence
   creating-a-cordapp
   running-the-demos
   node-administration
   corda-configuration-files

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

   where-to-start
   tutorial-contract
   tutorial-contract-clauses
   tutorial-test-dsl
   tutorial-clientrpc-api
   protocol-state-machines
   oracles
   tutorial-attachments
   event-scheduling
   secure-coding-guidelines

.. toctree::
   :maxdepth: 2
   :caption: Contracts

   contract-catalogue
   contract-irs

.. toctree::
   :maxdepth: 2
   :caption: Node API

   clientrpc

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

   release-process
   release-notes
   network-simulator
   codestyle
   building-the-docs
Add a page that briefly describes the proposed release process. 2016-05-10 16:44:41 +00:00			`Welcome to the Corda repository!`
			`================================`
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
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			`.. warning:: This build of the docs is from the master branch, not a milestone release. It may not reflect the`
			`current state of the code.`

Added Corda Whitepaper 2016-08-11 12:57:41 +00:00			This documentation describes Corda, a proposed architecture for distributed ledgers, the vision for which is outlined in the `Corda Introductory Whitepaper`_.

			.. _`Corda Introductory Whitepaper`: _static/corda-introductory-whitepaper.pdf
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
Add a page that briefly describes the proposed release process. 2016-05-10 16:44:41 +00:00			`The goal of this prototype is to explore fundamentally better designs for distributed ledgers than what presently exists`
			`on the market, tailor made for the needs of the financial industry. We are attempting to prove or disprove the`
			`following hypothesis:`
Fill out roadmap doc page and state the core hypothesis that the prototype is exploring on the welcome page. 2015-12-01 14:05:08 +00:00
Add a page that briefly describes the proposed release process. 2016-05-10 16:44:41 +00:00			`The combination of`
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
Add a page that briefly describes the proposed release process. 2016-05-10 16:44:41 +00:00			`* An upgraded state transition model`
			`* Industry standard, production quality virtual machines and languages`
			`* An advanced orchestration framework`
			`* Limited data propagation`
			`* Conflict resolution without proof of work or blocks`
Docs: add link from docsite to api docs 2016-03-08 17:32:13 +00:00
Add a page that briefly describes the proposed release process. 2016-05-10 16:44:41 +00:00			`is sufficiently powerful to justify the creation of a new platform implementation.`
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`
Docs: regen HTML + reorganise left hand menu a bit. 2015-12-22 15:15:38 +00:00			`:caption: Overview`
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`
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`
Docs: misc markup fixes and adjust an out of date paragraph about oracles. 2016-05-17 17:40:53 +00:00			`consensus`
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`
Review fixes. 2016-08-24 14:33:43 +00:00			`creating-a-cordapp`
Docsite: add info on how to run the IRS demo and rename the demos section 2016-04-18 17:44:21 +00:00			`running-the-demos`
Add a section to the docsite about node administration, cover attachment upload/download. 2016-03-04 15:15:32 +00:00			`node-administration`
docs Include database config section for completeness Incorporate comments from review Incorporate comments from review 2016-08-31 08:48:19 +00:00			`corda-configuration-files`
# 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: add a doc that describes how to link the other tutorials together into a demo. 2016-05-18 14:42:56 +00:00			`where-to-start`
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 docs/source/example-code module, tutorial on the Client RPC API 2016-10-04 12:56:31 +00:00			`tutorial-clientrpc-api`
Messaging: add docs on the messaging and protocol state machine systems. 2015-12-14 17:22:21 +00:00			`protocol-state-machines`
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`
Add a short document that describes things to watch out for when writing Corda app code. 2016-09-06 13:59:41 +00:00			`secure-coding-guidelines`
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`
			`:caption: Contracts`

			`contract-catalogue`
			`contract-irs`

			`.. toctree::`
			`:maxdepth: 2`
			`:caption: Node API`

			`clientrpc`

Docs: regen HTML + reorganise left hand menu a bit. 2015-12-22 15:15:38 +00:00			`.. toctree::`
			`:maxdepth: 2`
			`:caption: Appendix`

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 documentation for network simulator 2016-09-16 10:57:37 +00:00			`network-simulator`
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`