From 25a84c3c00cddcc2bcd29ed714daa63b7701a762 Mon Sep 17 00:00:00 2001 From: thephez Date: Thu, 31 Aug 2023 16:38:32 -0400 Subject: [PATCH 1/3] docs: add card grid to landing page --- docs/index.md | 88 ++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 87 insertions(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 8e6aef021..4309adbe9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,7 +4,93 @@ # Platform docs -Welcome to the Dash Platform developer documentation. +Welcome to the Dash Platform developer documentation. You'll find guides and documentation to help +you start working with Dash Platform and building decentralized applications based on the Dash +cryptocurrency. Let's jump right in! + +```{eval-rst} +.. grid:: 1 2 3 3 + + .. grid-item-card:: 💡 Introduction + :margin: 2 2 auto auto + :link-type: ref + :link: reference-index + + Background information about Dash + + +++ + :ref:`Click to begin ` + + .. grid-item-card:: 💻 Tutorials + :margin: 2 2 auto auto + :link-type: ref + :link: api-rpc + + Basics of building with Dash Platform + + +++ + :ref:`Click to begin ` + + .. grid-item-card:: 📑 Explanations + :margin: 2 2 auto auto + :link-type: ref + :link: guide-index + + Descriptions of Dash Platform features + + +++ + :ref:`Click to begin ` + + .. grid-item-card:: 📚 Reference + :margin: 2 2 auto auto + :link-type: ref + :link: examples-index + + API endpoint details and technical information + + +++ + :ref:`Click to begin ` + + .. grid-item-card:: 🔍 Platform Protocol Reference + :margin: 2 2 auto auto + :link-type: ref + :link: dashcore-arguments-and-commands + + Dash Platform protocol reference + + +++ + :ref:`Click to begin ` + + .. grid-item-card:: 🛠️ Dash SDK + :margin: 2 2 auto auto + :link-type: ref + :link: resources-glossary + + JavaScript SDK documentation + + +++ + :ref:`Click to begin ` + + .. grid-item-card:: 📖 Resources + :margin: 2 2 auto auto + :link-type: ref + :link: resources-glossary + + Links to helpful sites and tools + + +++ + :ref:`Click to begin ` + + .. grid-item-card:: 🛠️ DAPI Client + :margin: 2 2 auto auto + :link-type: ref + :link: resources-glossary + + JavaScript DAPI-Client documentation + + +++ + :ref:`Click to begin ` +``` ```{toctree} :maxdepth: 2 From 4f170af9b7111173b9c659437e54bba7fd770b11 Mon Sep 17 00:00:00 2001 From: thephez Date: Thu, 31 Aug 2023 16:58:54 -0400 Subject: [PATCH 2/3] docs: add labels and fix links on cards --- docs/dapi-client-js/overview.md | 4 ++++ docs/explanations/dapi.md | 4 ++++ docs/index.md | 32 +++++++++++++-------------- docs/intro/what-is-dash.md | 4 ++++ docs/protocol-ref/overview.md | 4 ++++ docs/reference/dapi-endpoints.md | 4 ++++ docs/resources/repository-overview.md | 4 ++++ docs/sdk-js/overview.md | 4 ++++ docs/tutorials/introduction.md | 4 ++++ 9 files changed, 48 insertions(+), 16 deletions(-) diff --git a/docs/dapi-client-js/overview.md b/docs/dapi-client-js/overview.md index 4d975cdf2..e30895b85 100644 --- a/docs/dapi-client-js/overview.md +++ b/docs/dapi-client-js/overview.md @@ -1,3 +1,7 @@ +```{eval-rst} +.. _dapi-client-js-index: +``` + # Overview ## DAPI-Client diff --git a/docs/explanations/dapi.md b/docs/explanations/dapi.md index 69ea2ce78..9a69e1a98 100644 --- a/docs/explanations/dapi.md +++ b/docs/explanations/dapi.md @@ -1,3 +1,7 @@ +```{eval-rst} +.. _explanations-dapi: +``` + # Decentralized API (DAPI) ## Overview diff --git a/docs/index.md b/docs/index.md index 4309adbe9..c7a5b9605 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,82 +14,82 @@ cryptocurrency. Let's jump right in! .. grid-item-card:: 💡 Introduction :margin: 2 2 auto auto :link-type: ref - :link: reference-index + :link: intro-index Background information about Dash +++ - :ref:`Click to begin ` + :ref:`Click to begin ` .. grid-item-card:: 💻 Tutorials :margin: 2 2 auto auto :link-type: ref - :link: api-rpc + :link: tutorials-intro Basics of building with Dash Platform +++ - :ref:`Click to begin ` + :ref:`Click to begin ` .. grid-item-card:: 📑 Explanations :margin: 2 2 auto auto :link-type: ref - :link: guide-index + :link: explanations-dapi Descriptions of Dash Platform features +++ - :ref:`Click to begin ` + :ref:`Click to begin ` .. grid-item-card:: 📚 Reference :margin: 2 2 auto auto :link-type: ref - :link: examples-index + :link: reference-dapi-endpoints API endpoint details and technical information +++ - :ref:`Click to begin ` + :ref:`Click to begin ` .. grid-item-card:: 🔍 Platform Protocol Reference :margin: 2 2 auto auto :link-type: ref - :link: dashcore-arguments-and-commands + :link: protocol-ref-overview Dash Platform protocol reference +++ - :ref:`Click to begin ` + :ref:`Click to begin ` .. grid-item-card:: 🛠️ Dash SDK :margin: 2 2 auto auto :link-type: ref - :link: resources-glossary + :link: sdk-js-index JavaScript SDK documentation +++ - :ref:`Click to begin ` + :ref:`Click to begin ` .. grid-item-card:: 📖 Resources :margin: 2 2 auto auto :link-type: ref - :link: resources-glossary + :link: resources-repository-overview Links to helpful sites and tools +++ - :ref:`Click to begin ` + :ref:`Click to begin ` .. grid-item-card:: 🛠️ DAPI Client :margin: 2 2 auto auto :link-type: ref - :link: resources-glossary + :link: dapi-client-js-index JavaScript DAPI-Client documentation +++ - :ref:`Click to begin ` + :ref:`Click to begin ` ``` ```{toctree} diff --git a/docs/intro/what-is-dash.md b/docs/intro/what-is-dash.md index 7cc511fa5..67af7ab7a 100644 --- a/docs/intro/what-is-dash.md +++ b/docs/intro/what-is-dash.md @@ -1,3 +1,7 @@ +```{eval-rst} +.. _intro-index: +``` + # What is Dash [block:image] diff --git a/docs/protocol-ref/overview.md b/docs/protocol-ref/overview.md index bdaae166a..a73b4a8ec 100644 --- a/docs/protocol-ref/overview.md +++ b/docs/protocol-ref/overview.md @@ -1,3 +1,7 @@ +```{eval-rst} +.. _protocol-ref-overview: +``` + # Overview ## Introduction diff --git a/docs/reference/dapi-endpoints.md b/docs/reference/dapi-endpoints.md index 66f20fbc4..1b89eedb6 100644 --- a/docs/reference/dapi-endpoints.md +++ b/docs/reference/dapi-endpoints.md @@ -1,3 +1,7 @@ +```{eval-rst} +.. _reference-dapi-endpoints: +``` + # DAPI Endpoints [DAPI](../explanations/dapi.md) currently provides 2 types of endpoints: [JSON-RPC](https://www.jsonrpc.org/) and [gRPC](https://grpc.io/docs/guides/). The JSON-RPC endpoints expose some layer 1 information while the gRPC endpoints support layer 2 as well as streaming of events related to blocks and transactions/transitions. diff --git a/docs/resources/repository-overview.md b/docs/resources/repository-overview.md index 94b03f3d6..f2e390aa4 100644 --- a/docs/resources/repository-overview.md +++ b/docs/resources/repository-overview.md @@ -1,3 +1,7 @@ +```{eval-rst} +.. _resources-repository-overview: +``` + # Repository Overview > 📘 Change to monorepo diff --git a/docs/sdk-js/overview.md b/docs/sdk-js/overview.md index 8ecc33dd6..672614a26 100644 --- a/docs/sdk-js/overview.md +++ b/docs/sdk-js/overview.md @@ -1,3 +1,7 @@ +```{eval-rst} +.. _sdk-js-index: +``` + # Overview [![NPM Version](https://img.shields.io/npm/v/dash)](https://www.npmjs.org/package/dash) diff --git a/docs/tutorials/introduction.md b/docs/tutorials/introduction.md index 62773d5fd..40eecfbde 100644 --- a/docs/tutorials/introduction.md +++ b/docs/tutorials/introduction.md @@ -1,3 +1,7 @@ +```{eval-rst} +.. _tutorials-intro: +``` + # Introduction The tutorials in this section walk through the steps necessary to begin building on Dash Platform using the Dash JavaScript SDK. As all communication happens via the masternode hosted decentralized API (DAPI), you can begin using Dash Platform immediately without running a local blockchain node. From bcfc11ea74d79852b1c5c6fbbf5eb613128e801e Mon Sep 17 00:00:00 2001 From: thephez Date: Thu, 31 Aug 2023 17:02:29 -0400 Subject: [PATCH 3/3] docs: adjust order of cards --- docs/index.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/index.md b/docs/index.md index c7a5b9605..df2f31bcc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -61,25 +61,25 @@ cryptocurrency. Let's jump right in! +++ :ref:`Click to begin ` - .. grid-item-card:: 🛠️ Dash SDK + .. grid-item-card:: 📖 Resources :margin: 2 2 auto auto :link-type: ref - :link: sdk-js-index + :link: resources-repository-overview - JavaScript SDK documentation + Links to helpful sites and tools +++ - :ref:`Click to begin ` + :ref:`Click to begin ` - .. grid-item-card:: 📖 Resources + .. grid-item-card:: 🛠️ Dash SDK :margin: 2 2 auto auto :link-type: ref - :link: resources-repository-overview + :link: sdk-js-index - Links to helpful sites and tools + JavaScript SDK documentation +++ - :ref:`Click to begin ` + :ref:`Click to begin ` .. grid-item-card:: 🛠️ DAPI Client :margin: 2 2 auto auto