-
Notifications
You must be signed in to change notification settings - Fork 3.8k
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
Update docs website #5827
Conversation
Code blocks indeed look much better on my windows laptop, thanks @fadeev! |
@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} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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} |
There was a problem hiding this 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 |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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} |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
Co-Authored-By: billy rennekamp <billy.rennekamp@gmail.com>
There was a problem hiding this 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.
thiis is good to merge right? @fadeev |
@marbar3778 staging looks good to me. So I would say, yes. |
@Mergifyio refresh |
Command |
Fixes issues with code-blocks, formatting, etc.
Preview: https://docs.staging-cosmos.network/