Update docs website (#5827)

* query-lifecycle and started modules-interfaces * query-lifecycle first draft done * module interfaces first draft * rest and intro skeletons * rest and intro done * small edits and links * comments * revisions * cli.md comments * comments * minor edits * better flow for query lifecycle * add transactions into core * hans comments * add transactions into core * checkout master-docs files * deleted some * remove modules readme * cli.md comments * comments * module-interfaces comments * Merge PR #4857: Add Context concept doc * working * working * finish messages and queries * handler * querier * last comments! * punctuation * querier2 * consolidate intro * querier * workiiiing * refactor for new module interface * karoly review * working on baseapp doc * baseapp work * reorg * almost there * finish first draft * remove old files * finish intro * workinnn * initial commit after rebase * query-lifecycle and started modules-interfaces * query-lifecycle first draft done * module interfaces first draft * rest and intro skeletons * rest and intro done * small edits and links * comments * revisions * cli.md comments * comments * minor edits * better flow for query lifecycle * checkout master-docs files * deleted some * remove modules readme * cli.md comments * comments * module-interfaces comments * keeper * genesis * finish * Apply suggestions from code review Co-Authored-By: Hans Schoenburg <hschoenburg@users.noreply.github.com> * hans review * Update docs/core/baseapp.md Co-Authored-By: Hans Schoenburg <hschoenburg@users.noreply.github.com> * working * last comment * workin * Apply suggestions from code review * encoding and node * almost finish store * finish docs * fixes * fede comments + permalinks * hans review * add more permalinks * update docs theme version (#5239) * R4R: Docs Cleanup (#5246) * start * work * work * work * remove table of content * links intro * fix links * remove junk * cleanup * cleanup * work * finish cleanup * addback readmes * remove nft * fix links * remove dup * remove dup * remove dup * remove dup * remove dup * fix links * add subscribe events * refine rest * index page * sidebar * theme version * theme version * testing netlify * theme version * tooltip example * version * testing code embedding * reverting back * theme version * version * version * version * readme and version * cleanup * redo app anatomy * modules readme, theme version * theme version * fix modules list * theme version * new snippets * modules readme * update docs readme * modify synopsis * version * fix yaml * version * version * version * version * version * version * version * version * version * version * add hide banner * version * version * version * small fixes * modules readme, version * remove hotkeys dep, version * version * version * version * version * version * version * version * slight notice * fix links and hide * permalinks * small clean * version * resolve conflicts, add google analytics * fix merge remants * version * changelog 1/2 * Changelog: docs UI * version * remove merge conflicts * Code: Update link for Contributing to the docs to docs_readme * HTML/CSS: Update layout of homepage footer to match new layout in Figma * version * final modifs * modules, version * modules readme * link to module list from homepage * version * building modules link * version * version * fonts * version * version * fix link * fix package.json * links in explore sdk section * core concepts * version * change delimeters for frontmatter * frontmatter in comments * version * temp add tiny-cookie * fixed link issues * fixed styling issues, copy * hide frontmatter * hide frontmatter * layout fixes, padded ascii diagram * fira sans font for code * scrollbar color * move synopsis from frontmatter * move synopsis from frontmatter * code styling in synopsis fix * tutorial link * active headers * 404 fix * homepage links fix * fix link in footer * misc fixes * version * prerequisite links on mobile * version * version * Fix footer links * version * Fix permalink popup * Update version * package-lock.json * Update Questions section in the footer * Config for Algolia Docsearch * Update version * Update to the latest version of the theme * Use docs-staging as a branch for staging website * Update version * Add google analytics * Remove {hide} from Pre-Requisite Readings * Replace Riot with Discord Co-Authored-By: billy rennekamp <billy.rennekamp@gmail.com> * Fix yaml syntax error in docs * Fix formatting in keyring.md Co-authored-by: Gloria Zhao <gzhao408@berkeley.edu> Co-authored-by: gamarin <gautier@tendermint.com> Co-authored-by: Jack Zampolin <jack.zampolin@gmail.com> Co-authored-by: Hans Schoenburg <hschoenburg@users.noreply.github.com> Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> Co-authored-by: Alexander Bezobchuk <alexanderbez@users.noreply.github.com> Co-authored-by: billy rennekamp <billy.rennekamp@gmail.com>
2020-03-24 16:20:30 +00:00
parent 999a83d698
commit 43627d0d1c
37 changed files with 1315 additions and 668 deletions
@@ -1,11 +1,12 @@
 <!--
 order: 3
-synopsis: "This document describes how to create a commmand-line interface (CLI) for an [**application**](../basics/app-anatomy.md). A separate document for implementing a CLI for an SDK [**module**](../building-modules/intro.md) can be found [here](#../building-modules/module-interfaces.md#cli)."
 -->

 # Command-Line Interface 

-## Pre-requisite Readings {hide}
+This document describes how to create a commmand-line interface (CLI) for an [**application**](../basics/app-anatomy.md). A separate document for implementing a CLI for an SDK [**module**](../building-modules/intro.md) can be found [here](#../building-modules/module-interfaces.md#cli). {synopsis}
+
+## Pre-requisite Readings

 * [Lifecycle of a Query](./query-lifecycle.md) {prereq}

@@ -1,11 +1,12 @@
 <!--
 order: 1
-synopsis: Typically, SDK applications include interfaces to let end-users interact with the application. This document introduces the different types of interfaces for SDK applications. 
 -->

 # Interfaces

-## Pre-requisite Readings {hide}
+Typically, SDK applications include interfaces to let end-users interact with the application. This document introduces the different types of interfaces for SDK applications. {synopsis}
+
+## Pre-requisite Readings

 * [Anatomy of an SDK Application](../basics/app-anatomy.md) {prereq}
 * [Lifecycle of a Transaction](../basics/tx-lifecycle.md) {prereq}
@@ -1,16 +1,17 @@
 <!--
 order: 3
-synopsis: "This document describes how to configure and use the keyring and its various backends for an [**application**](../basics/app-anatomy.md). A separate document for implementing a CLI for an SDK [**module**](../building-modules/intro.md) can be found [here](#../building-modules/module-interfaces.md#cli)."
 -->

 # The keyring

+This document describes how to configure and use the keyring and its various backends for an [**application**](../basics/app-anatomy.md). A separate document for implementing a CLI for an SDK [**module**](../building-modules/intro.md) can be found [here](#../building-modules/module-interfaces.md#cli). {synopsis}
+
 Starting with the v0.38.0 release, Cosmos SDK comes with a new keyring implementation
 that provides a set of commands to manage cryptographic keys in a secure fashion. The
 new keyring supports multiple storage backends, some of which may not be available on
 all operating systems.

-## The 'os' backend
+## The `os` backend

 The `os` backend relies on operating system-specific defaults to handle key storage
 securely. Typically, operating systems credentials sub-systems handle passwords prompt,
@@ -33,7 +34,7 @@ client.
 designed to meet users' most common needs and provide them with a comfortable
 experience without compromising on security.

-## The 'file' backend
+## The `file` backend

 The `file` backend more closely resembles the keybase implementation used prior to
 v0.38.1. It stores the keyring encrypted within the apps configuration directory. This
@@ -52,7 +53,7 @@ $ (echo '1234567890'; echo '1234567890'; echo '1234567890') | gaiad collect-gent
 The first time you add a key to an empty keyring, you will be prompted to type the password twice.
 :::

-## The 'pass' backend
+## The `pass` backend

 The `pass` backend uses the [pass](https://www.passwordstore.org/) utility to manage on-disk
 encryption of keys' sensitive data and metadata. Keys are stored inside `gpg` encrypted files
@@ -76,13 +77,13 @@ $ pass init <GPG_KEY_ID>
 Replace `<GPG_KEY_ID>` with your GPG key ID. You can use your personal GPG key or an alternative
 one you may want to use specifically to encrypt the password store.

-## The 'test' backend
+## The `test` backend

 The `test` backend is a password-less variation of the `file` backend. Keys are stored
 unencrypted on disk. This backend is meant for testing purposes only and **should never be used
 in production environments**.

-## The 'kwallet' backend
+## The `kwallet` backend

 The `kwallet` backend uses `KDE Wallet Manager`, which comes installed by default on the
 GNU/Linux distributions that ships KDE as default desktop environment. Please refer to
@@ -1,11 +1,12 @@
 <!--
 order: 2
-synopsis: "This document describes the lifecycle of a query in a SDK application, from the user interface to application stores and back. The query will be referred to as `Query`."
 -->

 # Query Lifecycle

-## Pre-requisite Readings {hide}
+This document describes the lifecycle of a query in a SDK application, from the user interface to application stores and back. The query will be referred to as `Query`. {synopsis}
+
+## Pre-requisite Readings

 * [Introduction to Interfaces](./interfaces-intro.md) {prereq}

@@ -1,11 +1,12 @@
 <!--
 order: 4
-synopsis: "This document describes how to create a REST interface for an SDK **application**. A separate document for creating a [**module**](../building-modules/intro.md) REST interface can be found [here](#../module-interfaces.md#rest)."
 -->

 # REST Interface

-## Prerequisites {hide}
+This document describes how to create a REST interface for an SDK **application**. A separate document for creating a [**module**](../building-modules/intro.md) REST interface can be found [here](#../module-interfaces.md#rest). {synopsis}
+
+## Pre-requisite Readings

 - [Query Lifecycle](./query-lifecycle.md) {prereq}
 - [Application CLI](./cli.md) {prereq}