corda/docs/source/index.rst

Welcome to Corda !
==================

`Corda <https://www.corda.net/>`_ is an open-source blockchain platform. If you’d like a quick introduction to blockchains and how Corda is different, then watch this short video:

.. raw:: html

    <embed>
      <iframe src="https://player.vimeo.com/video/205410473" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
    </embed>

Want to see Corda running? Download our demonstration application `DemoBench <https://www.corda.net/downloads/>`_ or
follow our :doc:`quickstart guide </quickstart-index>`.

If you want to start coding on Corda, then familiarise yourself with the :doc:`key concepts </key-concepts>`, then read
our :doc:`Hello, World! tutorial </hello-world-introduction>`. For the background behind Corda, read the non-technical
`introductory white paper`_ or for more detail, the `technical white paper`_.

If you have questions or comments, then get in touch on `Slack <https://slack.corda.net/>`_ or ask a question on
`Stack Overflow <https://stackoverflow.com/questions/tagged/corda>`_ .

We look forward to seeing what you can do with Corda!

.. note:: You can read this site offline. Either `download the PDF`_ or download the Corda source code, run ``gradle buildDocs`` and you will have
   a copy of this site in the ``docs/build/html`` directory.

.. _`introductory white paper`: _static/corda-introductory-whitepaper.pdf
.. _`technical white paper`: _static/corda-technical-whitepaper.pdf
.. _`download the PDF`: _static/corda-developer-site.pdf

.. toctree::
   :caption: Development
   :maxdepth: 1

   quickstart-index.rst
   key-concepts.rst
   building-a-cordapp-index.rst
   tutorials-index.rst
   tools-index.rst
   node-internals-index.rst
   component-library-index.rst
   serialization-index.rst
   json.rst
   troubleshooting.rst

.. toctree::
   :caption: Operations
   :maxdepth: 2

   corda-nodes-index.rst
   corda-networks-index.rst
   azure-vm.rst
   aws-vm.rst
   loadtesting.rst
   building-container-images.rst

.. Documentation is not included in the pdf unless it is included in a toctree somewhere

.. conditional-toctree::
   :caption: Contents
   :maxdepth: 2
   :if_tag: pdfmode

   deterministic-modules.rst
   release-notes.rst
   changelog.rst

.. conditional-toctree::
   :caption: Design docs
   :maxdepth: 2
   :if_tag: htmlmode

   design/design-review-process.md
   design/certificate-hierarchies/design.md
   design/failure-detection-master-election/design.md
   design/float/design.md
   design/hadr/design.md
   design/kafka-notary/design.md
   design/monitoring-management/design.md
   design/sgx-integration/design.md
   design/sgx-infrastructure/design.md

.. conditional-toctree::
   :caption: Participate
   :maxdepth: 2
   :if_tag: htmlmode
   
   contributing-index.rst
   corda-repo-layout.rst
   deterministic-modules.rst
   release-notes
   changelog
-												Refresh for beta release (#819)

* Refresh for beta release

* Added reference label to Key Concepts

* whitespace added after links

											
										
										
											2017-06-08 16:15:46 +00:00
+								Welcome to Corda !
 								==================
-												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
-												Reword index page (#3782)


											
										
										
											2018-08-14 09:06:30 +00:00
+								`Corda <https://www.corda.net/>`_ is an open-source blockchain platform. If you’d like a quick introduction to blockchains and how Corda is different, then watch this short video:
-												Added Corda Whitepaper

											
										
										
											2016-08-11 12:57:41 +00:00
-												Refresh for beta release (#819)

* Refresh for beta release

* Added reference label to Key Concepts

* whitespace added after links

											
										
										
											2017-06-08 16:15:46 +00:00
+								.. raw:: html
-												Updates the docs landing page to give clear direction to new users.


											
										
										
											2017-01-10 10:18:38 +00:00
-												Refresh for beta release (#819)

* Refresh for beta release

* Added reference label to Key Concepts

* whitespace added after links

											
										
										
											2017-06-08 16:15:46 +00:00
+								    <embed>
 								      <iframe src="https://player.vimeo.com/video/205410473" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
 								    </embed>
-												Inform users about the newly available Corda training programs at startup and in the docsite.

											
										
										
											2017-02-28 15:29:21 +00:00
-												Replaces links to Discourse with Stack Overflow links.


											
										
										
											2017-10-30 10:09:08 +00:00
+								Want to see Corda running? Download our demonstration application `DemoBench <https://www.corda.net/downloads/>`_ or
 								follow our :doc:`quickstart guide </quickstart-index>`.
-												Provides clearer instructions on the 'Getting set up' page. Expands 'Troubleshooting' page.


											
										
										
											2017-01-31 12:59:24 +00:00
-												Replaces links to Discourse with Stack Overflow links.


											
										
										
											2017-10-30 10:09:08 +00:00
+								If you want to start coding on Corda, then familiarise yourself with the :doc:`key concepts </key-concepts>`, then read
-												Reflects tutorial changes and CorDapp build docs changes from release-V1.


											
										
										
											2017-11-16 15:31:52 +00:00
+								our :doc:`Hello, World! tutorial </hello-world-introduction>`. For the background behind Corda, read the non-technical
-												Replaces links to Discourse with Stack Overflow links.


											
										
										
											2017-10-30 10:09:08 +00:00
+								`introductory white paper`_ or for more detail, the `technical white paper`_.
-												Updates the docs landing page to give clear direction to new users.


											
										
										
											2017-01-10 10:18:38 +00:00
-												Removes the glossary and FAQ. Points people to StackOverflow for troubleshooting.


											
										
										
											2018-03-16 13:41:38 +00:00
+								If you have questions or comments, then get in touch on `Slack <https://slack.corda.net/>`_ or ask a question on
-												Replaces links to Discourse with Stack Overflow links.


											
										
										
											2017-10-30 10:09:08 +00:00
+								`Stack Overflow <https://stackoverflow.com/questions/tagged/corda>`_ .
-												Refresh for beta release (#819)

* Refresh for beta release

* Added reference label to Key Concepts

* whitespace added after links

											
										
										
											2017-06-08 16:15:46 +00:00
-												Adds a link to Hello, Word. Other minor fixes.


											
										
										
											2017-06-20 10:26:36 +00:00
+								We look forward to seeing what you can do with Corda!
-												Docs: add link from docsite to api docs

											
										
										
											2016-03-08 17:32:13 +00:00
-												Generate a PDF version of the docsite. Request from a user in Slack.

											
										
										
											2018-03-28 14:36:08 +00:00
+								.. note:: You can read this site offline. Either `download the PDF`_ or download the Corda source code, run ``gradle buildDocs`` and you will have
 								   a copy of this site in the ``docs/build/html`` directory.
-												Adds a link to Hello, Word. Other minor fixes.


											
										
										
											2017-06-20 10:26:36 +00:00
+								.. _`introductory white paper`: _static/corda-introductory-whitepaper.pdf
 								.. _`technical white paper`: _static/corda-technical-whitepaper.pdf
-												Generate a PDF version of the docsite. Request from a user in Slack.

											
										
										
											2018-03-28 14:36:08 +00:00
+								.. _`download the PDF`: _static/corda-developer-site.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
 								.. toctree::
-												Docs: re-organise the toctree a bit more and introduce a design section

It includes (for now) just the design template.

											
										
										
											2018-05-11 15:32:19 +00:00
+								   :caption: Development
-												Refresh for beta release (#819)

* Refresh for beta release

* Added reference label to Key Concepts

* whitespace added after links

											
										
										
											2017-06-08 16:15:46 +00:00
+								   :maxdepth: 1
-												Further docsite changes, including reorganising the index.


											
										
										
											2017-06-07 15:14:01 +00:00
 								   quickstart-index.rst
 								   key-concepts.rst
 								   building-a-cordapp-index.rst
 								   tutorials-index.rst
 								   tools-index.rst
 								   node-internals-index.rst
 								   component-library-index.rst
-												[ENT-1955] Documentation fixes (#3417)


											
										
										
											2018-06-21 15:57:30 +00:00
+								   serialization-index.rst
-												Docs: move json to the development section (#3343)


											
										
										
											2018-06-11 15:13:45 +00:00
+								   json.rst
-												[ENT-1955] Documentation fixes (#3417)


											
										
										
											2018-06-21 15:57:30 +00:00
+								   troubleshooting.rst
-												Docs: reorganise the left hand table of contents.

It now has an app dev section, an operations section, and a "participate" section.

											
										
										
											2018-05-11 15:15:06 +00:00
 								.. toctree::
 								   :caption: Operations
 								   :maxdepth: 2
 								   corda-nodes-index.rst
 								   corda-networks-index.rst
-												Docs: re-organise the toctree a bit more and introduce a design section

It includes (for now) just the design template.

											
										
										
											2018-05-11 15:32:19 +00:00
+								   azure-vm.rst
 								   aws-vm.rst
 								   loadtesting.rst
-												CORDA-1585 - Tidy up participate docs + pdf toctree backport (#3674)

* Fix TOC for HTML and PDF (Backport from Enterprise docs)

* Tidy up participate section

* Address review comments

											
										
										
											2018-07-24 09:05:57 +00:00
+								   building-container-images.rst
-												Docs: re-organise the toctree a bit more and introduce a design section

It includes (for now) just the design template.

											
										
										
											2018-05-11 15:32:19 +00:00
-												[ENT-1955] Documentation fixes (#3417)


											
										
										
											2018-06-21 15:57:30 +00:00
+								.. Documentation is not included in the pdf unless it is included in a toctree somewhere
-												CORDA-1585 - Tidy up participate docs + pdf toctree backport (#3674)

* Fix TOC for HTML and PDF (Backport from Enterprise docs)

* Tidy up participate section

* Address review comments

											
										
										
											2018-07-24 09:05:57 +00:00
 								.. conditional-toctree::
 								   :caption: Contents
 								   :maxdepth: 2
 								   :if_tag: pdfmode
 								   deterministic-modules.rst
 								   release-notes.rst
 								   changelog.rst
 								.. conditional-toctree::
 								   :caption: Design docs
 								   :maxdepth: 2
 								   :if_tag: htmlmode
 								   design/design-review-process.md
 								   design/certificate-hierarchies/design.md
 								   design/failure-detection-master-election/design.md
 								   design/float/design.md
 								   design/hadr/design.md
 								   design/kafka-notary/design.md
 								   design/monitoring-management/design.md
 								   design/sgx-integration/design.md
 								   design/sgx-infrastructure/design.md
 								.. conditional-toctree::
 								   :caption: Participate
 								   :maxdepth: 2
 								   :if_tag: htmlmode
 								   contributing-index.rst
 								   corda-repo-layout.rst
 								   deterministic-modules.rst
 								   release-notes
 								   changelog