Skip to content

Commit 42f85e9

Browse files
authored
Merge pull request #5422 from input-output-hk/mgalazyn/doc/move-docs-cardano-node-wiki
Move `doc/` to cardano-node-wiki
2 parents d0af815 + 383abd8 commit 42f85e9

File tree

96 files changed

+8
-22071
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+8
-22071
lines changed

.readthedocs.yml

Lines changed: 0 additions & 11 deletions
This file was deleted.

CONTRIBUTING.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Contributing to the ``cardano-node`` project
44

55
The ``cardano-node`` development is primarily based on the Nix infrastructure (https://nixos.org/ ), which enables packaging, CI, development environments and deployments.
66

7-
On how to set up Nix for ``cardano-node`` development, please see `Building Cardano Node with nix <https://github.com/input-output-hk/cardano-node/tree/master/doc/getting-started/building-the-node-using-nix.md>`_.
7+
On how to set up Nix for ``cardano-node`` development, please see `Building Cardano Node with nix <https://github.com/input-output-hk/cardano-node-wiki/blob/main/doc/getting-started/building-the-node-using-nix.md>`_.
88

99

1010
Roles and Responsibilities
@@ -30,7 +30,7 @@ Testing
3030

3131
``cardano-node`` is essentially a container which implements several components such networking, consensus, and storage. These components have individual test coverage. The node goes through integration and release testing by Devops/QA while automated CLI tests are ongoing alongside development.
3232

33-
Developers on ``cardano-node`` can `launch their own testnets <doc/getting-started/launching-a-testnet.md>`_ or `run the chairman tests <doc/getting-started/running-chairman-tests.md>`_ locally.
33+
Developers on ``cardano-node`` can `launch their own testnets <https://github.com/input-output-hk/cardano-node-wiki/blob/main/doc/getting-started/launching-a-testnet.md>`_ or `run the chairman tests <https://github.com/input-output-hk/cardano-node-wiki/blob/main/doc/getting-started/running-chairman-tests.md>`_ locally.
3434

3535
Debugging
3636
====

README.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ The general synopsis is as follows:
118118

119119
* ``--start-as-non-producing-node`` - Optional flag to disable block production on node
120120
start. If credentials flags are passed the node will start block producing, however with
121-
this flag the node will only start block producing on SIGHUP (see `here <doc/reference/dynamic-block-forging.md>` for more details)
121+
this flag the node will only start block producing on SIGHUP (see `here <https://github.com/input-output-hk/cardano-node-wiki/blob/main/doc/reference/dynamic-block-forging.md>` for more details)
122122

123123
* ``--socket-path`` - Path to the socket file.
124124

@@ -154,7 +154,7 @@ Using ``cardano-cli``
154154
****
155155

156156
A CLI utility to support a variety of key material operations (genesis, migration, pretty-printing..) for different system generations.
157-
Usage documentation can be found at ``cardano-cli/README.md``.
157+
Usage documentation can be found at ``https://github.com/input-output-hk/cardano-cli/tree/master/cardano-cli/README.md``.
158158

159159
The general synopsis is as follows:
160160

@@ -213,7 +213,7 @@ The Byron genesis generation operations will create a directory that contains:
213213
* ``poor-keys.*.key``:
214214
Non-delegate private keys with genesis UTxO. Affected by: ``--n-poor-addresses``, ``--total-balance``.
215215

216-
More details on the Byron Genesis ``JSON`` file can be found in ``docs/reference/byron-genesis.md``
216+
More details on the Byron Genesis ``JSON`` file can be found in ``https://github.com/input-output-hk/cardano-node-wiki/blob/main/doc/reference/byron-genesis.md``
217217

218218
Byron genesis delegation and related concepts are described in detail in:
219219

@@ -434,11 +434,11 @@ To help you get started, see:
434434

435435
- `Ledger explanations: native tokens <https://cardano-ledger.readthedocs.io/en/latest/>`_. Covers explainers about assets, tokens, token bundles, minting policies, comparison to ERC20, and minimum ada value requirements.
436436

437-
- `A tutorial on how to get started with native tokens <./doc/reference/native-tokens/02-getting-started.md>`_. Explains how to create new currencies and assets, submit and send transactions containing multi-asset tokens, send and receive token bundles, manage your addresses and values.
437+
- `A tutorial on how to get started with native tokens <https://github.com/input-output-hk/cardano-node-wiki/blob/main/doc/reference/native-tokens/02-getting-started.md>`_. Explains how to create new currencies and assets, submit and send transactions containing multi-asset tokens, send and receive token bundles, manage your addresses and values.
438438

439-
- `Native tokens exercises <./doc/reference/native-tokens/03-exercises.md>`_
439+
- `Native tokens exercises <https://github.com/input-output-hk/cardano-node-wiki/blob/main/doc/reference/native-tokens/03-exercises.md>`_
440440

441-
To start, please ensure that you are familiar with setting up and operating the `Cardano node <https://github.com/input-output-hk/cardano-node>`_. Alternatively, see instructions on how to `start your node <https://github.com/input-output-hk/cardano-node/blob/master/doc/stake-pool-operations/2_start_your_nodes.md>`_ to submit the commands. You will not need to set up and start a full block producing node ('stake pool'), just a much simpler relay node. This node will need to connect to a Cardano network that is capable of processing native tokens (e.g., the native token pre-production environment (PPE), or the Cardano mainnet).
441+
To start, please ensure that you are familiar with setting up and operating the `Cardano node <https://github.com/input-output-hk/cardano-node>`_. Alternatively, see instructions on how to `start your node <https://github.com/input-output-hk/cardano-node-wiki/blob/main/doc/stake-pool-operations/2_start_your_nodes.md>`_ to submit the commands. You will not need to set up and start a full block producing node ('stake pool'), just a much simpler relay node. This node will need to connect to a Cardano network that is capable of processing native tokens (e.g., the native token pre-production environment (PPE), or the Cardano mainnet).
442442

443443
****
444444
API Documentation

bors.toml

Lines changed: 0 additions & 7 deletions
This file was deleted.

doc/.sphinx/_static/css/custom.css

Lines changed: 0 additions & 148 deletions
This file was deleted.

doc/.sphinx/_templates/layout.html

Lines changed: 0 additions & 7 deletions
This file was deleted.

doc/.sphinx/cardano-logo.png

-19.7 KB
Binary file not shown.

doc/.sphinx/requirements.txt

Lines changed: 0 additions & 31 deletions
This file was deleted.

0 commit comments

Comments
 (0)