From d6017615a28f37f95bff1603534e83f2b66f21b4 Mon Sep 17 00:00:00 2001 From: holgerd77 Date: Mon, 28 Aug 2017 22:40:02 +0200 Subject: Added note on outdated docs, seek for help --- docs/contribute.rst | 3 ++- docs/index.rst | 5 +++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/contribute.rst b/docs/contribute.rst index efd984a8f..02055b463 100644 --- a/docs/contribute.rst +++ b/docs/contribute.rst @@ -9,7 +9,8 @@ documentation tool. Since the `Ethereum tests `_ repository is very large to clone locally, a convenient way to contribute to the documentation is to -make a fork of the test repo, add the changes online with the GitHub markdown editor +make a fork of the test repo, add the changes online with the GitHub +`reStructuredText `_ editor and then open a PR. If you want to clone to your desk you might want to make use of ``git clone --depth 1`` diff --git a/docs/index.rst b/docs/index.rst index 02977a2a6..cfd45916f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,6 +7,10 @@ Ethereum Tests | This section describes basic test concepts and templates which are created by cpp-client. | +.. note:: + Larger parts of the test docs are currently outdated (see :ref:`contribute` on how to + help). + .. toctree:: :maxdepth: 2 :caption: Contents: @@ -20,6 +24,7 @@ Ethereum Tests vm_tests/index.rst contribute.rst + Indices and tables ================== -- cgit