From 9a5cf5c0ab2094524f28f155595969f65420b1f2 Mon Sep 17 00:00:00 2001 From: Abit Date: Sun, 1 Oct 2023 11:45:28 +0200 Subject: [PATCH 1/4] Update Doxygen links in README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6d44225ff..253870745 100644 --- a/README.md +++ b/README.md @@ -191,7 +191,7 @@ Use `gethelp ` to see more info about individual commands. E.G. The definition of all commands is available in the [wallet.hpp](https://github.com/bitshares/bitshares-core/blob/master/libraries/wallet/include/graphene/wallet/wallet.hpp) souce code file. -Corresponding documentation can be found in the [Doxygen documentation](https://doxygen.bitshares.org/classgraphene_1_1wallet_1_1wallet__api.html). +Corresponding documentation can be found in the [Doxygen documentation](https://bitshares.github.io/doxygen/classgraphene_1_1wallet_1_1wallet__api.html). You can run the program with `--help` parameter to see more info: @@ -211,7 +211,7 @@ Questions can be posted in [Github Discussions](https://github.com/bitshares/bit BitShares UI bugs should be reported to the [UI issue tracker](https://github.com/bitshares/bitshares-ui/issues). -Up to date online Doxygen documentation can be found at [Doxygen.BitShares.org](https://doxygen.bitshares.org/hierarchy.html). +Up to date online Doxygen documentation can be found at [https://bitshares.github.io/doxygen](https://bitshares.github.io/doxygen/hierarchy.html). Using Built-In APIs @@ -246,8 +246,8 @@ The definition of all node APIs is available in the source code files including [database_api.hpp](https://github.com/bitshares/bitshares-core/blob/master/libraries/app/include/graphene/app/database_api.hpp) and [api.hpp](https://github.com/bitshares/bitshares-core/blob/master/libraries/app/include/graphene/app/api.hpp). Corresponding documentation can be found in Doxygen: -* [database API](https://doxygen.bitshares.org/classgraphene_1_1app_1_1database__api.html) -* [other APIs](https://doxygen.bitshares.org/namespacegraphene_1_1app.html) +* [database API](https://bitshares.github.io/doxygen/classgraphene_1_1app_1_1database__api.html) +* [other APIs](https://bitshares.github.io/doxygen/namespacegraphene_1_1app.html) ### Wallet API @@ -320,8 +320,8 @@ The restricted API sets are accessible via HTTP too using *basic access authenti $ curl --data '{"jsonrpc": "2.0", "method": "call", "params": ["network_node", "add_node", ["127.0.0.1:9090"]], "id": 1}' http://bytemaster:supersecret@127.0.0.1:8090/ Our `doxygen` documentation contains the most up-to-date information -about APIs for the [node](https://doxygen.bitshares.org/namespacegraphene_1_1app.html) and the -[wallet](https://doxygen.bitshares.org/classgraphene_1_1wallet_1_1wallet__api.html). +about APIs for the [node](https://bitshares.github.io/doxygen/namespacegraphene_1_1app.html) and the +[wallet](https://bitshares.github.io/doxygen/classgraphene_1_1wallet_1_1wallet__api.html). FAQ From 26a435052a02f3ba6fffc770888e433fb4b850ea Mon Sep 17 00:00:00 2001 From: Abit Date: Sun, 1 Oct 2023 12:11:20 +0200 Subject: [PATCH 2/4] Fix typos Thanks https://github.com/omahs for https://github.com/bitshares/bitshares-core/pull/2784 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 253870745..a5276441f 100644 --- a/README.md +++ b/README.md @@ -190,7 +190,7 @@ Use `gethelp ` to see more info about individual commands. E.G. >>> gethelp get_order_book The definition of all commands is available in the -[wallet.hpp](https://github.com/bitshares/bitshares-core/blob/master/libraries/wallet/include/graphene/wallet/wallet.hpp) souce code file. +[wallet.hpp](https://github.com/bitshares/bitshares-core/blob/master/libraries/wallet/include/graphene/wallet/wallet.hpp) source code file. Corresponding documentation can be found in the [Doxygen documentation](https://bitshares.github.io/doxygen/classgraphene_1_1wallet_1_1wallet__api.html). You can run the program with `--help` parameter to see more info: @@ -304,7 +304,7 @@ Note: the `login` API set is always accessible. Passwords are stored in `base64` as salted `sha256` hashes. A simple Python script, [`saltpass.py`](https://github.com/bitshares/bitshares-core/blob/master/programs/witness_node/saltpass.py) -is avaliable to obtain hash and salt values from a password. +is available to obtain hash and salt values from a password. A single asterisk `"*"` may be specified as username or password hash to accept any value. With the above configuration, here is an example of how to call the `add_node` API from the `network_node` API set: From 8019ed9562f0b2fe3014fd5b5628b86a0d408d7f Mon Sep 17 00:00:00 2001 From: Abit Date: Sun, 1 Oct 2023 12:13:48 +0200 Subject: [PATCH 3/4] Fix typos Thanks to https://github.com/omahs for https://github.com/bitshares/bitshares-core/pull/2784 --- libraries/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/libraries/README.md b/libraries/README.md index 06f7fc9b8..065066e68 100644 --- a/libraries/README.md +++ b/libraries/README.md @@ -1,8 +1,8 @@ # BitShares Libraries -The libraries are the core of the project and defines everything where applications can build on top. +The libraries are the core of the project and define everything where applications can build on top. -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. +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. Code in libraries is the most important part of **bitshares-core** project and it is maintained by the Bitshares Core Team and contributors. # Available Libraries From 24e733b8af08feb797c2832ae1bb1f79e9c15a3a Mon Sep 17 00:00:00 2001 From: Abit Date: Sun, 1 Oct 2023 12:16:49 +0200 Subject: [PATCH 4/4] Fix a typo Thanks to https://github.com/omahs for https://github.com/bitshares/bitshares-core/pull/2784 --- programs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/programs/README.md b/programs/README.md index c7ddb86b4..43d9cae81 100644 --- a/programs/README.md +++ b/programs/README.md @@ -2,7 +2,7 @@ The bitshares programs are a collection of binaries to run the blockchain, interact with it or utilities. -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. +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. Programs in here are part of the **bitshares-core** project and are maintained by the bitshares core team and contributors.