Skip to content

Commit 2d44e48

Browse files
authored
Merge pull request #2786 from bitshares/update-doxygen-links
Update Doxygen links in README.md
2 parents 5799660 + 24e733b commit 2d44e48

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -190,8 +190,8 @@ Use `gethelp <COMMAND>` to see more info about individual commands. E.G.
190190
>>> gethelp get_order_book
191191

192192
The definition of all commands is available in the
193-
[wallet.hpp](https://github.com/bitshares/bitshares-core/blob/master/libraries/wallet/include/graphene/wallet/wallet.hpp) souce code file.
194-
Corresponding documentation can be found in the [Doxygen documentation](https://doxygen.bitshares.org/classgraphene_1_1wallet_1_1wallet__api.html).
193+
[wallet.hpp](https://github.com/bitshares/bitshares-core/blob/master/libraries/wallet/include/graphene/wallet/wallet.hpp) source code file.
194+
Corresponding documentation can be found in the [Doxygen documentation](https://bitshares.github.io/doxygen/classgraphene_1_1wallet_1_1wallet__api.html).
195195

196196
You can run the program with `--help` parameter to see more info:
197197

@@ -211,7 +211,7 @@ Questions can be posted in [Github Discussions](https://github.com/bitshares/bit
211211

212212
BitShares UI bugs should be reported to the [UI issue tracker](https://github.com/bitshares/bitshares-ui/issues).
213213

214-
Up to date online Doxygen documentation can be found at [Doxygen.BitShares.org](https://doxygen.bitshares.org/hierarchy.html).
214+
Up to date online Doxygen documentation can be found at [https://bitshares.github.io/doxygen](https://bitshares.github.io/doxygen/hierarchy.html).
215215

216216

217217
Using Built-In APIs
@@ -246,8 +246,8 @@ The definition of all node APIs is available in the source code files including
246246
[database_api.hpp](https://github.com/bitshares/bitshares-core/blob/master/libraries/app/include/graphene/app/database_api.hpp)
247247
and [api.hpp](https://github.com/bitshares/bitshares-core/blob/master/libraries/app/include/graphene/app/api.hpp).
248248
Corresponding documentation can be found in Doxygen:
249-
* [database API](https://doxygen.bitshares.org/classgraphene_1_1app_1_1database__api.html)
250-
* [other APIs](https://doxygen.bitshares.org/namespacegraphene_1_1app.html)
249+
* [database API](https://bitshares.github.io/doxygen/classgraphene_1_1app_1_1database__api.html)
250+
* [other APIs](https://bitshares.github.io/doxygen/namespacegraphene_1_1app.html)
251251

252252

253253
### Wallet API
@@ -304,7 +304,7 @@ Note: the `login` API set is always accessible.
304304

305305
Passwords are stored in `base64` as salted `sha256` hashes. A simple Python script,
306306
[`saltpass.py`](https://github.com/bitshares/bitshares-core/blob/master/programs/witness_node/saltpass.py)
307-
is avaliable to obtain hash and salt values from a password.
307+
is available to obtain hash and salt values from a password.
308308
A single asterisk `"*"` may be specified as username or password hash to accept any value.
309309

310310
With the above configuration, here is an example of how to call the `add_node` API from the `network_node` API set:
@@ -320,8 +320,8 @@ The restricted API sets are accessible via HTTP too using *basic access authenti
320320
$ curl --data '{"jsonrpc": "2.0", "method": "call", "params": ["network_node", "add_node", ["127.0.0.1:9090"]], "id": 1}' http://bytemaster:[email protected]:8090/
321321

322322
Our `doxygen` documentation contains the most up-to-date information
323-
about APIs for the [node](https://doxygen.bitshares.org/namespacegraphene_1_1app.html) and the
324-
[wallet](https://doxygen.bitshares.org/classgraphene_1_1wallet_1_1wallet__api.html).
323+
about APIs for the [node](https://bitshares.github.io/doxygen/namespacegraphene_1_1app.html) and the
324+
[wallet](https://bitshares.github.io/doxygen/classgraphene_1_1wallet_1_1wallet__api.html).
325325

326326

327327
FAQ

libraries/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# BitShares Libraries
22

3-
The libraries are the core of the project and defines everything where applications can build on top.
3+
The libraries are the core of the project and define everything where applications can build on top.
44

5-
A **graphene** blockchain software will use the `app` library to define what the application will do, what services it will offer. The blockchain is defined by the `chain` library and include all the objects, types, operations, protocols that builds current consensus blockchain. The lowest level in memory database of Bitshares is developed at the `db` library. The `fc` is a helper module broadly used in the libraries code, `egenesis` will help with the genesis file, `plugins` will be loaded optionally to the application. Wallet software like the cli_wallet will benefit from the `wallet` library.
5+
A **graphene** blockchain software will use the `app` library to define what the application will do, what services it will offer. The blockchain is defined by the `chain` library and includes all the objects, types, operations, protocols that build current consensus blockchain. The lowest level in memory database of Bitshares is developed at the `db` library. The `fc` is a helper module broadly used in the libraries code, `egenesis` will help with the genesis file, `plugins` will be loaded optionally to the application. Wallet software like the cli_wallet will benefit from the `wallet` library.
66

77
Code in libraries is the most important part of **bitshares-core** project and it is maintained by the Bitshares Core Team and contributors.
88
# Available Libraries

programs/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The bitshares programs are a collection of binaries to run the blockchain, interact with it or utilities.
44

5-
The main program is the `witness_node`, used to run a bitshares block producer, API or plugin node. The second in importance is the `cli_wallet`, used to interact with the blockchain. This 2 programs are the most used by the community and updated by the developers, rest of the programs are utilities.
5+
The main program is the `witness_node`, used to run a bitshares block producer, API or plugin node. The second in importance is the `cli_wallet`, used to interact with the blockchain. These 2 programs are the most used by the community and updated by the developers, rest of the programs are utilities.
66

77
Programs in here are part of the **bitshares-core** project and are maintained by the bitshares core team and contributors.
88

0 commit comments

Comments
 (0)