Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs website #5827

Merged
merged 304 commits into from
Mar 24, 2020
Merged

Update docs website #5827

merged 304 commits into from
Mar 24, 2020

Conversation

fadeev
Copy link
Contributor

@fadeev fadeev commented Mar 18, 2020

Fixes issues with code-blocks, formatting, etc.

Preview: https://docs.staging-cosmos.network/

@fadeev fadeev added the T:Docs Changes and features related to documentation. label Mar 18, 2020
@fadeev fadeev requested a review from gamarin2 March 18, 2020 17:42
@gamarin2
Copy link
Contributor

Code blocks indeed look much better on my windows laptop, thanks @fadeev!

@fadeev
Copy link
Contributor Author

fadeev commented Mar 20, 2020

@gamarin2 @alexanderbez @hschoenburg @alessio @fedekunze when you get a chance, can you please review this PR?

-->

# Encoding

> NOTE: This document a WIP.
The `codec` is used everywhere in the Cosmos SDK to encode and decode structs and interfaces. The specific codec used in the Cosmos SDK is called `go-amino`. {synopsis}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The `codec` is used everywhere in the Cosmos SDK to encode and decode structs and interfaces. The specific codec used in the Cosmos SDK is called `go-amino`. {synopsis}
The `codec` is used everywhere in the Cosmos SDK to encode and decode structs and interfaces. The specific codec used in the Cosmos SDK is called `go-amino` but will switch to `protobuf` in the near future. {synopsis}

Copy link
Contributor

@okwme okwme left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small suggestions but otherwise LGTM

## Pre-requisite Readings {hide}
This document describes the default strategies to handle gas and fees within a Cosmos SDK application. {synopsis}

### Pre-requisite Readings
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do you delete the {hide} banner in some places and not others?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

{hide} hides the block, unless it's the "Pre-requisite Readings", which is shown no matter what (on purpose).

I've removed {hide} from all "Pre-requisite Readings" to avoid confusion.

-->

# Node Client (Daemon)

The main endpoint of an SDK application is the daemon client, otherwise known as the full-node client. The full-node runs the state-machine, starting from a genesis file. It connects to peers running the same client in order to receive and relay transactions, block proposals and signatures. The full-node is constituted of the application, defined with the Cosmos SDK, and of a consensus engine connected to the application via the ABCI. {synopsis}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do you spot the synopsis without frontmatter?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We used to have synopsis in front-matter, but we've switched to {synopsis} syntax.

fadeev and others added 2 commits March 20, 2020 21:16
Co-Authored-By: billy rennekamp <billy.rennekamp@gmail.com>
Copy link
Contributor

@jgimeno jgimeno left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, I like the Introduction messages for every section.

@fadeev fadeev mentioned this pull request Mar 24, 2020
11 tasks
@tac0turtle
Copy link
Member

thiis is good to merge right? @fadeev

@fadeev
Copy link
Contributor Author

fadeev commented Mar 24, 2020

@marbar3778 staging looks good to me. So I would say, yes.

@tac0turtle tac0turtle added the A:automerge Automatically merge PR once all prerequisites pass. label Mar 24, 2020
@tac0turtle
Copy link
Member

@Mergifyio refresh

@mergify mergify bot merged commit 43627d0 into master Mar 24, 2020
@mergify mergify bot deleted the docs-staging branch March 24, 2020 16:20
@mergify
Copy link
Contributor

mergify bot commented Mar 24, 2020

Command refresh: success

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass. T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants