Skip to content

Commit

Permalink
docs: move documentation from github.com/desmos-labs/docs (#1046)
Browse files Browse the repository at this point in the history
## Description

Closes: #XXXX

<!-- Add a description of the changes that this PR introduces and the
files that
are the most critical to review. -->

This PR moves the documention from https://github.com/desmos-labs/docs
into the `docs` folder.

---

### Author Checklist

*All items are required. Please add a note to the item if the item is
not applicable and
please add links to any relevant follow up issues.*

I have...

- [x] included the correct [type
prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json)
in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] targeted the correct branch (see [PR
Targeting](https://github.com/desmos-labs/desmos/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building
modules](https://docs.cosmos.network/v0.44/building-modules/intro.html)
- [ ] included the necessary unit and integration
[tests](https://github.com/desmos-labs/desmos/blob/master/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go
code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [x] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable
and please add
your handle next to the items reviewed if you only reviewed selected
items.*

I have...

- [ ] confirmed the correct [type
prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json)
in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
  • Loading branch information
manu0466 authored Nov 29, 2022
1 parent ac5daea commit e39c58b
Show file tree
Hide file tree
Showing 1,635 changed files with 77,026 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Dependencies
/node_modules

# Production
/build
/docs/.idea

# Generated files
.docusaurus
.cache-loader
*.lock

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Modules docs
docs/02-developers/02-modules/*

# Copied folders
docs/architecture
48 changes: 48 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Desmos Docs
This folder contains the documentation of Desmos Network hosted on https://docs.desmos.network.
Feel free to open issues/PRs to contribute!

## Installation

```console
yarn install
```

## Local Development

```console
yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live
without having to restart the server.

## Update graphql schemas (if needed)
If a new Desmos release also updated graphql schemas, it's required to also update the related schema files. To do it, run the following command in the project directory:

```console
npx docusaurus graphql-to-doc
```

If you want to read more about the graphql generator please check [here](https://www.npmjs.com/package/@edno/docusaurus2-graphql-doc-generator) the docs of the plugin we are using.

## Build

```console
yarn build
```

```console
docusaurus build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Serve

```console
docusaurus serve
```

### Credits
> Docs powered by [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
5 changes: 5 additions & 0 deletions docs/architecture/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "ADRs",
"position": 8,
"collapsed": true
}
3 changes: 3 additions & 0 deletions docs/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
25 changes: 25 additions & 0 deletions docs/docs/01-intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
id: intro
title: Introduction
slug: /
sidebar_position: 1
---
# Introduction

![cover](../static/assets/cover.png)

Desmos is a Proof of Stake blockchain protocol that allows developers to build social networking or social-enable apps.

Inside this documentation you will find all the instructions in order to:

- Setup a full node and become a Desmos validator earning $DSMs while sustaining the chain;
- Fix commons validators/full-node problems.
- Use Desmos to build a social-network or social-enabled app;

Being thought for developers or sysadmins, you will find that most of the terms are very technical. However, in order for newcomers to get on board easily, we will also provide you with useful links that redirects you to the proper documentation on third party websites.

To get started, use the navigation bar to move through the pages.

:::tip WELCOME
Welcome to a whole new era of social networks.
:::
38 changes: 38 additions & 0 deletions docs/docs/02-developers/01-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
id: overview
title: Overview
sidebar_label: Overview
slug: overview
---
# Overview

## Introduction
[Desmos](../01-intro.md) aims to provide developers a protocol with which they will be able to create decentralized and censorship-resistant social enabled apps. Different apps, with different scopes and their own Term of Services will be able to use the features offered by Desmos to customize their user experience in a unique way.

If you want to know more about the base concepts of a blockchain and understand some key points, please take a look at the [FAQ page](07-faq.md).

## Core features
The core features of Desmos are organised in **modules** following the specification of the [Cosmos-SDK](https://docs.cosmos.network/main/building-modules/intro.html).

Here a brief description of each one of these:

* `Profiles`: Handles the creation and management of a decentralized identity and its own links with both your other chains wallets and centralised applications;

* `Relationships`: Handles the creation and management of mono-directional and bidirectional [relationships] between users' wallets. It also allows managing users blocks lists;

* `Subspaces`: Handles the creation and management of a [subspace] and their [sections] inside Desmos;

* `Posts`: Handles the creation and management of posts and their contents. These contents can include a variety of different attachments such as medias (pics, gifs, videos) and polls. Posts can also be enriched with a variety of [entities].

* `Reactions`: Handles the creation and management of reactions to posts;

* `Reports`: Handle the creation and management of posts' and users' reports.

## Support features
These features are not directly connected to the social-networks scope but serve the network maintainers and
external services.

* `Fees`: Allows setting custom additional fees to modules' messages;
* `Supply`: Allows retrieving information about a particular token total and circulating supply.

If you want to know more about each module, its concepts and how to interact with them check the [modules] section.
Loading

0 comments on commit e39c58b

Please sign in to comment.