corda/docs/source/index.rst

114 lines
3.4 KiB
ReStructuredText
Raw Normal View History

Welcome to Corda !
==================
2018-08-14 09:06:30 +00:00
`Corda <https://www.corda.net/>`_ is an open-source blockchain platform. If youd like a quick introduction to blockchains and how Corda is different, then watch this short video:
2016-08-11 12:57:41 +00:00
.. 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
2018-10-04 09:45:55 +00:00
`platform 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.
2018-10-04 09:45:55 +00:00
.. _`platform white paper`: _static/corda-platform-whitepaper.pdf
.. _`technical white paper`: _static/corda-technical-whitepaper.pdf
.. _`download the PDF`: _static/corda-developer-site.pdf
.. toctree::
:maxdepth: 1
release-notes
app-upgrade-notes
.. 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
2018-06-21 15:57:30 +00:00
serialization-index.rst
json.rst
2018-06-21 15:57:30 +00:00
troubleshooting.rst
.. toctree::
:caption: Operations
:maxdepth: 2
corda-nodes-index.rst
corda-networks-index.rst
2019-01-08 15:52:24 +00:00
docker.rst
azure-vm.rst
aws-vm.rst
loadtesting.rst
cli-application-shell-extensions.rst
2018-06-21 15:57:30 +00:00
.. 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/reference-states/design.md
design/sgx-infrastructure/design.md
design/threat-model/corda-threat-model.md
design/data-model-upgrades/signature-constraints.md
design/data-model-upgrades/package-namespace-ownership.md
design/targetversion/design.md
.. conditional-toctree::
:caption: Participate
:maxdepth: 2
:if_tag: htmlmode
2019-01-08 15:52:24 +00:00
contributing-index.rst
corda-repo-layout.rst
deterministic-modules.rst
changelog
2018-10-18 17:19:14 +00:00
.. conditional-toctree::
:caption: Corda Network
:maxdepth: 2
:if_tag: htmlmode
corda-network/index.md
corda-network/governance-structure.md
corda-network/governance-guidelines.md
corda-network/joining-corda-network.md