Skip to content

Commit

Permalink
Update documentation links in README
Browse files Browse the repository at this point in the history
  • Loading branch information
Denis Shevchenko committed Oct 16, 2020
1 parent f8e1407 commit 2e1d8e8
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.rst
Expand Up @@ -52,7 +52,22 @@ Also, you can download the latest CI builds from Hydra:
Documentation
=============

The documentation is published `here <https://docs.cardano.org/en/latest/rt-view/rt-view.html>`_. But you can also read this documentation right `on GitHub <https://github.com/input-output-hk/cardano-rt-view/tree/master/doc>`_.
Recommended topics:

* `Overview <https://docs.cardano.org/en/latest/rt-view/rt-view.html>`_
* `Quick start <https://github.com/input-output-hk/cardano-rt-view/blob/master/doc/getting-started/install.md>`_
* `Configure your nodes <https://github.com/input-output-hk/cardano-rt-view/blob/master/doc/getting-started/node-configuration.md>`_
* `GUI overview <https://github.com/input-output-hk/cardano-rt-view/blob/master/doc/gui-overview/overview.md>`_

Additional topics:

* `Build RTView from sources <https://github.com/input-output-hk/cardano-rt-view/blob/master/doc/getting-started/building-rt-view-from-sources.md>`_
* `Learn more about RTView configuration <https://github.com/input-output-hk/cardano-rt-view/blob/master/doc/getting-started/rt-view-configuration.md>`_
* `Understanding node's metrics <https://github.com/input-output-hk/cardano-rt-view/blob/master/doc/technical-details/understanding-metrics.md>`_

Use cases:

* `Distributed mode: step by step <https://github.com/input-output-hk/cardano-rt-view/blob/master/doc/use-cases/different-machines.md>`_

.. raw:: html

Expand Down

0 comments on commit 2e1d8e8

Please sign in to comment.