mirror of
https://github.com/corda/corda.git
synced 2024-12-25 07:31:10 +00:00
116 lines
2.8 KiB
ReStructuredText
116 lines
2.8 KiB
ReStructuredText
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
|