Skip to content

Commit

Permalink
link bugs fixed (because the mainnet.md and testnet.md are moved.)
Browse files Browse the repository at this point in the history
  • Loading branch information
smalloranges committed Mar 7, 2020
1 parent d0fbef3 commit a5f5411
Show file tree
Hide file tree
Showing 23 changed files with 644 additions and 1,242 deletions.
16 changes: 8 additions & 8 deletions docs/go-nebulas/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,19 @@ Getting started
To get the basic concepts of Nebulas visit the Nebulas homepage over at
`nebulas.io <https://nebulas.io>`_. If you want to get a deeper understanding, start by
reading the `technical whitepaper <https://nebulas.io/docs/NebulasTechnicalWhitepaper.pdf>`_ and `non-technical whitepaper <https://nebulas.io/docs/NebulasWhitepaper.pdf>`_.To
be a contributor, visit `how to contribute <../how-to-contribute>`_.
be a contributor, visit `how to contribute <../how-to-contribute.html>`_.

For getting started guides and documents, see here:

.. toctree::
:titlesonly:

Design <design-overview/README.md>
Design <design-overview/README.rst>
Infrastructure <infrastructure/README.rst>
Joining the Blockchain <blockchain/README.rst>
Tutorials <tutorials/README.rst>
DApp Development <dapp-development/README.rst>
Developer Blog <develop/README.md>
Developer Blog <develop/README.rst>


Downloads
Expand Down Expand Up @@ -54,26 +54,26 @@ Nebulas NOVA launched in the end of 2018. There are three features:
- Developer Incentive Protocol: provide native on-chain incentive for developers


`Click here`_ to learn about Nebulas NOVA. Some articles:
`Click here to learn about Nebulas NOVA <https://nebulas.io/nova.html>`_ . Some articles:

- `Nebulas NOVA, To Discover Data Value In the Blockchain
World <https://medium.com/nebulasio/nebulas-nova-to-discover-data-value-in-the-blockchain-world-83bbb5cde05c>`_, [`Youtube <https://www.youtube.com/watch?v=jLIYkG35Ljo>`_]
- 6 Minutes Learning Nebulas NOVA with 92k Lines of Code by Joel Wang [`Youtube <https://www.youtube.com/watch?v=lT0yKkNdO48>`_]

The third important version will be launch in 2020 with PoD consensus mechanism. `Click here <../node-strategy/README.rst>`_ to learn about the PoD Node Strategy.
The third important version will be launch in 2020 with PoD consensus mechanism. `Click here to learn about the PoD Node Strategy <../node-strategy/README.rst>`_ .

`Click here to learn how to join the mainnet <blockchain/mainnet>`_.
`Click here to learn how to join the mainnet <blockchain/mainnet.html>`_.


Testnet
-------

A functional equivalent `Nebulas Testnet <https://testnet.nebulas.io>`_ is available now, allowing developers to interact with Nebulas freely. View: `How to join the testnet <blockchain/testnet>`_.
A functional equivalent `Nebulas Testnet <https://testnet.nebulas.io>`_ is available now, allowing developers to interact with Nebulas freely. View: `How to join the testnet <blockchain/testnet.html>`_.

Roadmap
-------

Nebulas releases are `here <https://github.com/nebulasio/go-nebulas/releases>`_ and roadmap are `here <https://nebulas.io/roadmap.html>`_.
`Nebulas releases are here <https://github.com/nebulasio/go-nebulas/releases>`_ and `roadmap are here <https://nebulas.io/roadmap.html>`_.



11 changes: 7 additions & 4 deletions docs/go-nebulas/blockchain/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ Joining the Blockchain

Intent on joining the Nebulas Blockchain? Check out the following:

- `Joining the Mainnet` <mainnet.md>
- `Joining the Testnet` <testnet.md>
- `Configuration Files` <config.md>
- `Node Environment` <environment.md>
.. toctree::
:titlesonly:

mainnet.md
testnet.md
config.md
environment.md
2 changes: 1 addition & 1 deletion docs/go-nebulas/blockchain/config.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Configuration
# Configuration Files

There are four types of configuration files in Nebulas.

Expand Down
2 changes: 1 addition & 1 deletion docs/go-nebulas/blockchain/environment.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Nebulas node environment
# Node Environment

## Introduction

Expand Down
24 changes: 12 additions & 12 deletions docs/go-nebulas/blockchain/mainnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The Nebulas Mainnet's executable file and dependant libraries need to be built f
* **NBRE:** The Nebulas Blockchain Runtime Environment is the platform for running Nebulas Protocol Representation, such as the DIP, the NR, etcetera.
* **NEB:** The main process of the Nebulas Mainnet. `NEB` and `NBRE` run in standalone processes, and communicate through IPC.

Details of building the modules can be found in [tutorials](http://wiki.nebulas.io/en/latest/go-nebulas/tutorials/01-installation.html#compile-nebulas).
Details of building the modules can be found in [tutorials](../tutorials/01-installation.html#compile-nebulas).


### Configuration
Expand Down Expand Up @@ -91,23 +91,23 @@ Main Endpoint:
| --- | :---: | :---: |
| RESTful | [https://mainnet.nebulas.io/](https://mainnet.nebulas.io/) | HTTP |

* [GetNebState](dapp-development/rpc/README.html#getnebstate) : returns nebulas client info.
* [GetAccountState](dapp-development/rpc/README.html#getaccountstate): returns the account balance and nonce.
* [Call](dapp-development/rpc/README.html#call): execute smart contract local, don't submit on chain.
* [SendRawTransaction](dapp-development/rpc/README.html#sendrawtransaction): submit the signed transaction.
* [GetTransactionReceipt](dapp-development/rpc/README.html#gettransactionreceipt): get transaction receipt info by tansaction hash.
* [GetNebState](../dapp-development/rpc/README.html#getnebstate) : returns nebulas client info.
* [GetAccountState](../dapp-development/rpc/README.html#getaccountstate): returns the account balance and nonce.
* [Call](../dapp-development/rpc/README.html#call): execute smart contract local, don't submit on chain.
* [SendRawTransaction](../dapp-development/rpc/README.html#sendrawtransaction): submit the signed transaction.
* [GetTransactionReceipt](../dapp-development/rpc/README.html#gettransactionreceipt): get transaction receipt info by tansaction hash.

More Nebulas APIs at [RPC](dapp-development/rpc/README.html).
More Nebulas APIs at [RPC](../dapp-development/rpc/README).

## Tutorials

### English

1. [Installation](tutorials/01-installation.md) \(thanks [Victor](https://github.com/victorychain)\)
2. [Sending a Transaction](tutorials/02-transaction.md) \(thanks [Victor](https://github.com/victorychain)\)
3. [Writing Smart Contract in JavaScript](tutorials/03-smart-contracts-javascript.md) \(thanks [otto](https://github.com/ottokafka)\)
4. [Introducing Smart Contract Storage](tutorials/04-smart-contract-storage.md) \(thanks [Victor](https://github.com/victorychain)\)
5. [Interacting with Nebulas by RPC API](tutorials/05-interacting-with-nebulas-by-rpc-api.md) \(thanks [Victor](https://github.com/victorychain)\)
1. [Installation](../tutorials/01-installation.md) \(thanks [Victor](https://github.com/victorychain)\)
2. [Sending a Transaction](../tutorials/02-transaction.md) \(thanks [Victor](https://github.com/victorychain)\)
3. [Writing Smart Contract in JavaScript](../tutorials/03-smart-contracts-javascript.md) \(thanks [otto](https://github.com/ottokafka)\)
4. [Introducing Smart Contract Storage](../tutorials/04-smart-contract-storage.md) \(thanks [Victor](https://github.com/victorychain)\)
5. [Interacting with Nebulas by RPC API](../tutorials/05-interacting-with-nebulas-by-rpc-api.md) \(thanks [Victor](https://github.com/victorychain)\)


## Contribution
Expand Down
26 changes: 13 additions & 13 deletions docs/go-nebulas/blockchain/testnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The Nebulas Testnet's executable file and dependant libraries need to be built f

* **NEB:** The main process of the Nebulas Testnet. `NEB` and `NBRE` run in standalone processes, and communicate through IPC.

Details of building the modules can be found in [tutorials](http://wiki.nebulas.io/en/latest/go-nebulas/tutorials/01-installation.html#compile-nebulas).
Details of building the modules can be found in [tutorials](../tutorials/01-installation.html#compile-nebulas).

### Configuration
The testnet configuration files are in the folder [`testnet/conf`](https://github.com/nebulasio/go-nebulas/tree/testnet/testnet/conf) under `testnet` branch, including:
Expand Down Expand Up @@ -82,23 +82,23 @@ Test Endpoint:
| --- | :---: | :---: |
| RESTful | [https://testnet.nebulas.io/](https://testnet.nebulas.io/) | HTTP |

* [GetNebState](dapp-development/rpc/README.html#getnebstate) : returns nebulas client info.
* [GetAccountState](dapp-development/rpc/README.html#getaccountstate): returns the account balance and nonce.
* [Call](dapp-development/rpc/README.html#call): execute smart contract local, don't submit on chain.
* [SendRawTransaction](dapp-development/rpc/README.html#sendrawtransaction): submit the signed transaction.
* [GetTransactionReceipt](dapp-development/rpc/README.html#gettransactionreceipt): get transaction receipt info by tansaction hash.
* [GetNebState](../dapp-development/rpc/README.html#getnebstate) : returns nebulas client info.
* [GetAccountState](../dapp-development/rpc/README.html#getaccountstate): returns the account balance and nonce.
* [Call](../dapp-development/rpc/README.html#call): execute smart contract local, don't submit on chain.
* [SendRawTransaction](../dapp-development/rpc/README.html#sendrawtransaction): submit the signed transaction.
* [GetTransactionReceipt](../dapp-development/rpc/README.html#gettransactionreceipt): get transaction receipt info by tansaction hash.

More Nebulas APIs at [RPC](dapp-development/rpc/README.html).
More Nebulas APIs at [RPC](../dapp-development/rpc/README).

#### Claim Tokens
Each email can claim tokens every day [here](https://testnet.nebulas.io/claim).
[Each email can claim tokens every day here](https://testnet.nebulas.io/claim).

## Tutorials
1. [Installation](tutorials/01-installation.md) \(thanks [Victor](https://github.com/victorychain)\)
2. [Sending a Transaction](tutorials/02-transaction.md) \(thanks [Victor](https://github.com/victorychain)\)
3. [Writing Smart Contract in JavaScript](tutorials/03-smart-contracts-javascript.md) \(thanks [otto](https://github.com/ottokafka)\)
4. [Introducing Smart Contract Storage](tutorials/04-smart-contract-storage.md) \(thanks [Victor](https://github.com/victorychain)\)
5. [Interacting with Nebulas by RPC API](tutorials/05-interacting-with-nebulas-by-rpc-api.md) \(thanks [Victor](https://github.com/victorychain)\)
1. [Installation](../tutorials/01-installation.md) \(thanks [Victor](https://github.com/victorychain)\)
2. [Sending a Transaction](../tutorials/02-transaction.md) \(thanks [Victor](https://github.com/victorychain)\)
3. [Writing Smart Contract in JavaScript](../tutorials/03-smart-contracts-javascript.md) \(thanks [otto](https://github.com/ottokafka)\)
4. [Introducing Smart Contract Storage](../tutorials/04-smart-contract-storage.md) \(thanks [Victor](https://github.com/victorychain)\)
5. [Interacting with Nebulas by RPC API](../tutorials/05-interacting-with-nebulas-by-rpc-api.md) \(thanks [Victor](https://github.com/victorychain)\)


## Contributing
Expand Down
5 changes: 3 additions & 2 deletions docs/go-nebulas/dapp-development/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@ DApp Development
================

.. toctree::
:maxdepth: 2
:titlesonly:

smart_contract.md
smart-contract/README.rst
nrc20.md
nrc721.md
tools.md
rpc/README.md
rpc/README.rst
console.md
2 changes: 1 addition & 1 deletion docs/go-nebulas/dapp-development/console.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ admin.signTransactionWithPassphrase
admin.sendTransactionWithPassphrase
```

The command parameters of the command line are consistent with the parameters of the RPC interface. [NEB RPC](rpc/README.html) and [NEB RPC\_Admin](rpc/rpc_admin.md).
The command parameters of the command line are consistent with the parameters of the RPC interface. [NEB RPC](rpc/README) and [NEB RPC\_Admin](rpc/rpc_admin.md).

## console exit

Expand Down
2 changes: 1 addition & 1 deletion docs/go-nebulas/dapp-development/rpc/rpc_admin.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RPC Management

Beside the [NEB API RPC](README.html) interface nebulas provides additional management APIs. Neb console supports both API and management interfaces. Management RPC uses the same gRPC and HTTP port, which also binds [NEB API RPC](README.html) interfaces.
Beside the [NEB API RPC](README) interface nebulas provides additional management APIs. Neb console supports both API and management interfaces. Management RPC uses the same gRPC and HTTP port, which also binds [NEB API RPC](README.html) interfaces.

Nebulas provide both [gRPC](https://grpc.io) and RESTful management APIs for users to interact with Nebulas. Our admin [proto](https://github.com/nebulasio/go-nebulas/blob/develop/rpc/pb/rpc.proto) file defines all admin APIs. **We recommend using the console access admin interfaces, or restricting the admin RPC to local access.**

Expand Down

0 comments on commit a5f5411

Please sign in to comment.