-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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
docs: Remove deprecated "Interfaces" section #8294
Conversation
7ebf31b
to
ba95777
Compare
@@ -1,20 +0,0 @@ | |||
# Getting Started |
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.
I removed all docs from this folder. They mentioned LCD, gaia-lite, which I believe is all removed.
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.
cc @marbar3778 @alexanderbez : Are we okay to remove all docs from this folder?
@@ -1,70 +0,0 @@ | |||
<!-- |
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.
removed docs concerning legacy REST. We already have:
- docs for grpc-gateway
- migration from REST
@@ -1,35 +1,33 @@ | |||
<!-- |
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.
moving CLI to core concepts
@@ -1,5 +1,5 @@ | |||
<!-- |
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.
moving query-lifecycle to basics
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.
Let's confirm if we can remove lite client spec
docs/core/README.md
Outdated
11. [Object-Capabilities](./ocap.md) | ||
12. [RunTx recovery middleware](./runtx_middleware.md) | ||
13. [Simulation](./simulation.md) | ||
14. [Protobuf documentation](./proto-docs.md) |
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.
I think we should use markdown autonumeration. So use 1.
in every line to avoid useless changes.
failure? | ||
- Run invariants on every operation with `-SimulateEveryOperation`. _Note_: this | ||
will slow down your simulation **a lot**. | ||
- Try adding logs to operations that are not logged. You will have to define a |
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 changing *
to -
?
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.
my editor did this. I can change back if it bothers you.
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.
It's OK, but I think we should avoid this kind of changes (I mean improving a style is OK, but here we don't change it).
* Remove useless files, add app.toml section * Rework docs * Delete interfaces * add correct next section references * Finish CLI * Small tweaks query * Add simulation docs to core * Add gRPC and REST * Finish queyr lifecycle * Updat examples * Remove prereq * fix links in simulation * Use same enumeration in md Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
* Remove useless files, add app.toml section * Rework docs * Delete interfaces * add correct next section references * Finish CLI * Small tweaks query * Add simulation docs to core * Add gRPC and REST * Finish queyr lifecycle * Updat examples * Remove prereq * fix links in simulation * Use same enumeration in md Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Description
ref: #7661
The "Interfaces" section had the following docs:
lite
: removedquery-lifecycle
: moved to "basics", along withtx-lifecycle
, and reworked. renderedcli
: moved to "core concepts", alongs grpc, rest..., and reworked. renderedintro to interfaces
: removedrest
: removedThe simulation docs inside "Using the SDK" never showed up, I put them in Core Concepts, where they might belong more.
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/
) or specification (x/<module>/spec/
)godoc
comments.Unreleased
section inCHANGELOG.md
Files changed
in the Github PR explorerCodecov Report
in the comment section below once CI passes