From 67634eea1a7cf89597542619423d47656d7f120f Mon Sep 17 00:00:00 2001 From: thephez Date: Mon, 14 Aug 2023 14:19:23 -0400 Subject: [PATCH 1/3] chore: remove extraneous files and move unused ones --- docs/explanations/credits.md | 5 -- docs/intro/quickstart.md | 49 ------------------- docs/{explanations => other}/incentives.md | 0 docs/{reference => other}/key-concepts.md | 0 docs/reference/debugging.md | 3 -- .../decentralized-api-api-reference.md | 0 docs/resources/dips-improvement-proposals.md | 0 docs/resources/github-repositories.md | 24 --------- docs/resources/source-code-core-blockchain.md | 0 docs/resources/source-code-dapi-client.md | 0 .../source-code-dash-platform-protocol-dpp.md | 0 .../source-code-dash-sdk-javascript.md | 0 .../source-code-decentralized-api-dapi.md | 0 docs/resources/source-code-dpns-client.md | 0 .../source-code-dpns-data-contract.md | 0 docs/resources/source-code-drive.md | 0 .../source-code-network-deployment-tool.md | 0 docs/resources/testnet-status.md | 0 18 files changed, 81 deletions(-) delete mode 100644 docs/explanations/credits.md delete mode 100644 docs/intro/quickstart.md rename docs/{explanations => other}/incentives.md (100%) rename docs/{reference => other}/key-concepts.md (100%) delete mode 100644 docs/reference/debugging.md delete mode 100644 docs/reference/decentralized-api-api-reference.md delete mode 100644 docs/resources/dips-improvement-proposals.md delete mode 100644 docs/resources/github-repositories.md delete mode 100644 docs/resources/source-code-core-blockchain.md delete mode 100644 docs/resources/source-code-dapi-client.md delete mode 100644 docs/resources/source-code-dash-platform-protocol-dpp.md delete mode 100644 docs/resources/source-code-dash-sdk-javascript.md delete mode 100644 docs/resources/source-code-decentralized-api-dapi.md delete mode 100644 docs/resources/source-code-dpns-client.md delete mode 100644 docs/resources/source-code-dpns-data-contract.md delete mode 100644 docs/resources/source-code-drive.md delete mode 100644 docs/resources/source-code-network-deployment-tool.md delete mode 100644 docs/resources/testnet-status.md diff --git a/docs/explanations/credits.md b/docs/explanations/credits.md deleted file mode 100644 index 10828ae9f..000000000 --- a/docs/explanations/credits.md +++ /dev/null @@ -1,5 +0,0 @@ -# Creating - -# Withdrawing - -Requires a withdraw key (type: 3). Withdraw keys must have a [security level of Critical](https://github.com/dashevo/platform/pull/352) \ No newline at end of file diff --git a/docs/intro/quickstart.md b/docs/intro/quickstart.md deleted file mode 100644 index 746834879..000000000 --- a/docs/intro/quickstart.md +++ /dev/null @@ -1,49 +0,0 @@ -The quickest way to get started with Dash Platform is by completing these two simple steps: - -1. Install the Dash SDK to interact with the Dash Platform decentralized API (DAPI) -2. Verify a successful API response to a DAPI test request - -# 1. Install the Dash SDK - -The quickest way to start developing on Dash Platform is to use the Dash SDK. Currently, the SDK is available in Javascript, Objective-C, and Java. After navigating to your project directory, you can install the Javascript SDK by issuing the following command in your terminal or command line: - -```shell -npm install dash -``` - -Require the Dash SDK by adding the following code to your project’s index: - -** add code to project index ** - -See the library source on [GitHub](https://github.com/dashevo/platform/tree/master/packages/js-dash-sdk). - -# 2. Verify a successful API response - -To confirm proper installation, use `dash` to send a request to DAPI and check for a valid response. The example shown here requests the current height of the Dash blockchain: - -```javascript -const DAPIClient = require('@dashevo/dapi-client'); - -var client = new DAPIClient(); - -var blockHeight = client.getBestBlockHeight(); -blockHeight.then(height => { - console.log(`Best block height: ${height}`); -}); -``` - -A live example of this code can be run [here on Repl.it](https://repl.it/@thephez/DAPI-Client-Basic-Example) - -> 🚧 DAPI-Client Seed node(s) -> -> If using DAPI-Client in a devnet or testnet setting, at least one seed node must be provided in the constructor. For example, -> ```js -> var client = new DAPIClient({ -> seeds: [{ -> service: 'example.com:20001', -> port: 3000 -> }], -> }); -> ``` - -Once you have verified dapi-client requests are working, you can move on to exploring the available endpoints. \ No newline at end of file diff --git a/docs/explanations/incentives.md b/docs/other/incentives.md similarity index 100% rename from docs/explanations/incentives.md rename to docs/other/incentives.md diff --git a/docs/reference/key-concepts.md b/docs/other/key-concepts.md similarity index 100% rename from docs/reference/key-concepts.md rename to docs/other/key-concepts.md diff --git a/docs/reference/debugging.md b/docs/reference/debugging.md deleted file mode 100644 index f6f7b4eab..000000000 --- a/docs/reference/debugging.md +++ /dev/null @@ -1,3 +0,0 @@ -> 🚧 Under construction -> -> \ No newline at end of file diff --git a/docs/reference/decentralized-api-api-reference.md b/docs/reference/decentralized-api-api-reference.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/resources/dips-improvement-proposals.md b/docs/resources/dips-improvement-proposals.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/resources/github-repositories.md b/docs/resources/github-repositories.md deleted file mode 100644 index 106375a86..000000000 --- a/docs/resources/github-repositories.md +++ /dev/null @@ -1,24 +0,0 @@ -## [dashcore-lib](https://github.com/dashevo/dashcore-lib) -npm: `@dashevo/dashcore-lib` -This handles core network functions like managing private keys, creating and signing transactions, and verifying blocks, as well as some masternode-related functions such as fetching governance objects and the deterministic masternode list. Based on Bitcoin's bitcore-lib. - -## [dash-spv](https://github.com/dashevo/dash-spv) -npm: `@dashevo/dash-spv` -This offers [SPV](glossary#section-simple-payment-verification) functions on top of dashcore-lib to enable lightweight wallet clients that can start quickly and don't need to download the whole Dash blockchain. - -## [dapi-client](https://github.com/dashevo/platform/tree/master/packages/js-dapi-client) -npm: `@dashevo/dapi-client` -Enables interaction with Dash platform through the DAPI hosted on masternodes. Provides automatic masternode discovery starting from any initial masternode. -Uses dash-spv and dashcore-lib. - -## [js-dpp](https://github.com/dashevo/platform/tree/master/packages/js-dpp) -npm: `@dashevo/dpp` - -## [wallet-lib](https://github.com/dashevo/platform/tree/master/packages/wallet-lib) -npm: `@dashevo/wallet-lib` -Provides layer-1 spv wallet functions -Uses dapi-client, dashcore-lib, and js-dpp. - -## [DashJS](https://github.com/dashevo/platform/tree/master/packages/js-dash-sdk) -npm: `dash` -uses wallet-lib, dapi-client, and dashcore-lib to expose layer-1 and layer-2 functionality. Main user is app developers \ No newline at end of file diff --git a/docs/resources/source-code-core-blockchain.md b/docs/resources/source-code-core-blockchain.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/resources/source-code-dapi-client.md b/docs/resources/source-code-dapi-client.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/resources/source-code-dash-platform-protocol-dpp.md b/docs/resources/source-code-dash-platform-protocol-dpp.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/resources/source-code-dash-sdk-javascript.md b/docs/resources/source-code-dash-sdk-javascript.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/resources/source-code-decentralized-api-dapi.md b/docs/resources/source-code-decentralized-api-dapi.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/resources/source-code-dpns-client.md b/docs/resources/source-code-dpns-client.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/resources/source-code-dpns-data-contract.md b/docs/resources/source-code-dpns-data-contract.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/resources/source-code-drive.md b/docs/resources/source-code-drive.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/resources/source-code-network-deployment-tool.md b/docs/resources/source-code-network-deployment-tool.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/resources/testnet-status.md b/docs/resources/testnet-status.md deleted file mode 100644 index e69de29bb..000000000 From 63d8d3f3b15d44b126cb10bab4d84aeee8401031 Mon Sep 17 00:00:00 2001 From: thephez Date: Mon, 14 Aug 2023 14:20:11 -0400 Subject: [PATCH 2/3] chore: exclude other dir --- conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/conf.py b/conf.py index a7f21feac..9e9065267 100644 --- a/conf.py +++ b/conf.py @@ -32,7 +32,7 @@ ] templates_path = ['_templates'] -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'README.md', '.devcontainer', 'scripts', 'img/dev/gifs/README.md'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'README.md', '.devcontainer', 'scripts', 'img/dev/gifs/README.md', 'docs/other'] # The master toctree document. master_doc = 'index' From b0f835e8e960d241f5b0fa166f3c51fcbb11281c Mon Sep 17 00:00:00 2001 From: thephez Date: Mon, 14 Aug 2023 14:20:32 -0400 Subject: [PATCH 3/3] docs: correct heading levels --- docs/intro/what-is-dash-platform.md | 2 +- docs/tutorials/identities-and-names/retrieve-a-name.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/intro/what-is-dash-platform.md b/docs/intro/what-is-dash-platform.md index e2f225980..34767ea17 100644 --- a/docs/intro/what-is-dash-platform.md +++ b/docs/intro/what-is-dash-platform.md @@ -1,4 +1,4 @@ -## What is Dash Platform +# What is Dash Platform Dash Platform is a [Web3](https://en.wikipedia.org/wiki/Web3) technology stack for building decentralized applications on the Dash network. The two main architectural components, [Drive](explanation-drive) and [DAPI](explanation-dapi), turn the Dash P2P network into a cloud that developers can integrate with their applications. diff --git a/docs/tutorials/identities-and-names/retrieve-a-name.md b/docs/tutorials/identities-and-names/retrieve-a-name.md index a983ea566..01256317e 100644 --- a/docs/tutorials/identities-and-names/retrieve-a-name.md +++ b/docs/tutorials/identities-and-names/retrieve-a-name.md @@ -2,7 +2,7 @@ In this tutorial we will retrieve the name created in the [Register a Name for an Identity tutorial](tutorial-register-a-name-for-an-identity). Additional details regarding identities can be found in the [Identity description](explanation-identity). -### Prerequisites +## Prerequisites - [General prerequisites](tutorials-introduction#prerequisites) (Node.js / Dash SDK installed) ## Code