Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/dapi-client-js/overview.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
```{eval-rst}
.. _dapi-client-js-index:
```

# Overview

## DAPI-Client
Expand Down
4 changes: 4 additions & 0 deletions docs/explanations/dapi.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
```{eval-rst}
.. _explanations-dapi:
```

# Decentralized API (DAPI)

## Overview
Expand Down
88 changes: 87 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: intro-index

Background information about Dash

+++
:ref:`Click to begin <intro-index>`

.. grid-item-card:: 💻 Tutorials
:margin: 2 2 auto auto
:link-type: ref
:link: tutorials-intro

Basics of building with Dash Platform

+++
:ref:`Click to begin <tutorials-intro>`

.. grid-item-card:: 📑 Explanations
:margin: 2 2 auto auto
:link-type: ref
:link: explanations-dapi

Descriptions of Dash Platform features

+++
:ref:`Click to begin <explanations-dapi>`

.. grid-item-card:: 📚 Reference
:margin: 2 2 auto auto
:link-type: ref
:link: reference-dapi-endpoints

API endpoint details and technical information

+++
:ref:`Click to begin <reference-dapi-endpoints>`

.. grid-item-card:: 🔍 Platform Protocol Reference
:margin: 2 2 auto auto
:link-type: ref
:link: protocol-ref-overview

Dash Platform protocol reference

+++
:ref:`Click to begin <protocol-ref-overview>`

.. grid-item-card:: 📖 Resources
:margin: 2 2 auto auto
:link-type: ref
:link: resources-repository-overview

Links to helpful sites and tools

+++
:ref:`Click to begin <resources-repository-overview>`

.. grid-item-card:: 🛠️ Dash SDK
:margin: 2 2 auto auto
:link-type: ref
:link: sdk-js-index

JavaScript SDK documentation

+++
:ref:`Click to begin <sdk-js-index>`

.. grid-item-card:: 🛠️ DAPI Client
:margin: 2 2 auto auto
:link-type: ref
:link: dapi-client-js-index

JavaScript DAPI-Client documentation

+++
:ref:`Click to begin <dapi-client-js-index>`
```

```{toctree}
:maxdepth: 2
Expand Down
4 changes: 4 additions & 0 deletions docs/intro/what-is-dash.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
```{eval-rst}
.. _intro-index:
```

# What is Dash

[block:image]
Expand Down
4 changes: 4 additions & 0 deletions docs/protocol-ref/overview.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
```{eval-rst}
.. _protocol-ref-overview:
```

# Overview

## Introduction
Expand Down
4 changes: 4 additions & 0 deletions docs/reference/dapi-endpoints.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/resources/repository-overview.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
```{eval-rst}
.. _resources-repository-overview:
```

# Repository Overview

> 📘 Change to monorepo
Expand Down
4 changes: 4 additions & 0 deletions docs/sdk-js/overview.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
4 changes: 4 additions & 0 deletions docs/tutorials/introduction.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down