cb66c99eab
chore: add markdownlint to lint commands ( #9353 )
...
* add markdownlint config
* update make lint commands
* update markdownlint config
* run make lint-fix
* fix empty link
* resuse docker container
* run lint-fix
* do not echo commands
Co-authored-by: ryanchrypto <12519942+ryanchrypto@users.noreply.github.com>
2021-05-27 15:31:04 +00:00
f2cea6a137
doc: Updates related to ServiceMsg, sdk.Msg and Msg service ( #9294 )
...
* doc: Updates related to ServiceMsg, sdk.Msg and Msg service
* Apply suggestions from code review
Co-authored-by: Ryan Christoffersen <12519942+ryanchrypto@users.noreply.github.com>
* remove one more ServiceMsg
* Use service method rathr than service RPC
Co-authored-by: Ryan Christoffersen <12519942+ryanchrypto@users.noreply.github.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2021-05-12 15:47:54 +00:00
b635ae2090
Update docs for building modules ( #9272 )
...
* update example structure
* update example structure
* update module errors path
* update paths and fix typos
* update paths and fix typos
* update example structure
* address review comments
2021-05-07 18:13:06 -04:00
89cb9b0f8c
docs: uml hotfix ( #9124 )
...
* comment out ungenerated uml .svg in the md files
* generate svgs to docs/uml
* create docs/uml/svg
* move .punl to docs/uml/puml
* update uml path in md files
* docs: update relative path of uml svg in `x` md files
* docs: remove plantuml script from pre.sh
Co-authored-by: Marko <marbar3778@yahoo.com>
2021-04-16 07:59:21 +00:00
c41baa9bc8
PlantUML diagrams ( #8712 )
...
* Overview of keepers in object capability model (OCM)
* Updates to the spec, making clarifications
* Create a sequence diagram of a (fresh) delegation
* Misc notes, not yet decided where to put them
* Description of the shares abstraction in validators
* Model all keeper dependencies and move the UML file to docs
* Move and rename delegation sequence diagram
* Move shares description
* Remove TODO
* Diagram touch-ups
* Add how consensus power is calculated
* remove temp file
* Diagram improvements
* Describe slashing in more detail
* Describe redelegation
* Describe unbonding
* Delegation updates
* Delegation updates
* Make a diagram describing overall transaction flow
* Add delegation flows for the events of tokens being bonded/unbonding/etc.
* Grammar fix
* Diagram updates: distinguish alts, remove numbering.
* Use groups instead of "func:" participants
* Remove unused keepers from dependency diagram
* Add title to unbonding diagram
* Move keeper dependencies
* small doc updates
* remove numbers on sequence diagram
* !!!WIP EndBlock
* Explain "Last"-prefix in storage
* Remove `panic` step (they are supposed to never happen)
* EndBlock sequence diagram (with TODOs)
* Add TODO
* More visible TODOs
* Remove numbering
* Complete EndBlock
* Remove numbering
* Remove TODOs and update title
* add title back
* remove endblock seq-diagram
* Make power index update conditional on not being jailed
* update title
* Move files to /docs
* Install PlantUML and compile images to png and txt
* Use transaction flow in documentation
* Use staking UML in staking docs
* Clarify uml with inline doc
* Add keeper deps diagram to docs
* Only produce SVG images
Co-authored-by: hjort <>
Co-authored-by: Marko <marbar3778@yahoo.com>
2021-04-06 09:50:56 +00:00
36f68eb9e0
Update docs ( #8751 )
...
* docs/basics/app-anatomy.md: update code snippets
* Update outdated code snippets
* docs/basics/accounts.md: update code snippets
* Update outdated code snippets
* docs/core/baseapp.md: update code snippets
* Update outdated code snippets
* docs/core/node.md: update code snippets
* Update outdated code snippets
* docs/core/store.md: fixed typos
* docs/core/grpc_rest.md: fix typos
* docs/core/cli.md: fix typos
* docs/core/ocap.md: fix code snippet
* docs/building-modules/msg-services.md: fix snippet
* Update stale code snippets
* docs/building-modules/simulator.md: snippets fix
* Update outdated code snippet
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2021-03-16 12:14:54 +00:00
e481f13ff3
docs: cache-wrapping and virtual store ( #8102 )
...
* docs: cache-wrapping and virtual store
* Finish the docs update
* Update docs/building-modules/msg-services.md
Co-authored-by: Amaury <amaury.martiny@protonmail.com>
* Update docs/building-modules/msg-services.md
Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>
Co-authored-by: Amaury <amaury.martiny@protonmail.com>
Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>
2021-01-05 15:57:33 +00:00
ccd0d63f80
Update "Core Concepts" docs ( #7948 )
...
* Update "Core Concepts" docs
* Update tags
* Update more subsctions
* Revert basics
* ADd link to run-node
* Typo
* Add sign modes
* Finish transaction.md
* Update docs/core/baseapp.md
Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>
* Update docs/core/baseapp.md
Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>
* Update docs/core/baseapp.md
Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>
* Update docs/core/baseapp.md
Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>
* Update docs/core/baseapp.md
Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>
* Update docs/core/baseapp.md
Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>
* Wording
* Update docs/core/baseapp.md
Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>
* Revert basics changes
* revert space change
* typo
* Update docs/core/transactions.md
Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>
* Update docs/core/node.md
Co-authored-by: Robert Zaremba <robert@zaremba.ch>
* Update docs/core/store.md
Co-authored-by: Robert Zaremba <robert@zaremba.ch>
Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>
Co-authored-by: Robert Zaremba <robert@zaremba.ch>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2020-11-24 15:03:20 +00:00
1cc8af8d9b
[docs]: update building modules section to reflect ADR31 ( #7702 )
...
* Revert "Revert "Update old ref of RegisterQueryService""
This reverts commit 03e4c56de53938ccbf025a441e54b9842f7c4544.
* Update intro, module-manager and messages-and-queries
* Update messages-and-queries
* Update handler
* Update structure
* Add doc related to RegisterMsgServiceDesc
* Update docs/building-modules/handler.md
Co-authored-by: Robert Zaremba <robert@zaremba.ch>
* Update docs/building-modules/handler.md
Co-authored-by: Robert Zaremba <robert@zaremba.ch>
* Update docs/building-modules/handler.md
Co-authored-by: Robert Zaremba <robert@zaremba.ch>
* Update docs/building-modules/messages-and-queries.md
* Update handler.md
* Rename handler.md to msg-services.md
* Update legacy msgs wording
* Update messages-and-queries.md
* Update docs/building-modules/msg-services.md
Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>
* Update docs/building-modules/intro.md
Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>
* Remove handler mention from intro.md
* Update docs/building-modules/messages-and-queries.md
Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>
* Update docs/building-modules/messages-and-queries.md
Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>
* Update docs/building-modules/msg-services.md
Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>
* Update docs/building-modules/keeper.md
Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>
* Update docs/building-modules/msg-services.md
Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>
* Address review comments
* Use tag
* Update docs/building-modules/intro.md
Co-authored-by: Cory <cjlevinson@gmail.com>
* Update docs/building-modules/intro.md
Co-authored-by: Aaron Craelius <aaron@regen.network>
* Update docs/building-modules/messages-and-queries.md
Co-authored-by: Aaron Craelius <aaron@regen.network>
* Update docs/building-modules/messages-and-queries.md
Co-authored-by: Aaron Craelius <aaron@regen.network>
* Update docs/building-modules/messages-and-queries.md
Co-authored-by: Aaron Craelius <aaron@regen.network>
* Update docs/core/transactions.md
Co-authored-by: Aaron Craelius <aaron@regen.network>
* Update docs/building-modules/messages-and-queries.md
Co-authored-by: Aaron Craelius <aaron@regen.network>
* Update docs/building-modules/messages-and-queries.md
Co-authored-by: Aaron Craelius <aaron@regen.network>
* Update docs/building-modules/messages-and-queries.md
Co-authored-by: Aaron Craelius <aaron@regen.network>
* Update docs/building-modules/messages-and-queries.md
Co-authored-by: Aaron Craelius <aaron@regen.network>
* Remove framework related explanation from docs
* Update docs/building-modules/messages-and-queries.md
Co-authored-by: Aaron Craelius <aaron@regen.network>
* Update docs/building-modules/module-manager.md
Co-authored-by: Aaron Craelius <aaron@regen.network>
* Update docs/building-modules/module-manager.md
Co-authored-by: Aaron Craelius <aaron@regen.network>
* Update docs/building-modules/msg-services.md
Co-authored-by: Aaron Craelius <aaron@regen.network>
* Update docs/building-modules/msg-services.md
Co-authored-by: Aaron Craelius <aaron@regen.network>
* Update docs/building-modules/msg-services.md
Co-authored-by: Aaron Craelius <aaron@regen.network>
* Update docs/building-modules/msg-services.md
Co-authored-by: Aaron Craelius <aaron@regen.network>
* Update docs/building-modules/msg-services.md
Co-authored-by: Aaron Craelius <aaron@regen.network>
* Update docs/building-modules/msg-services.md
Co-authored-by: Aaron Craelius <aaron@regen.network>
* Update docs/building-modules/msg-services.md
Co-authored-by: Aaron Craelius <aaron@regen.network>
* Update docs/core/baseapp.md
Co-authored-by: Aaron Craelius <aaron@regen.network>
* Update docs/core/baseapp.md
Co-authored-by: Aaron Craelius <aaron@regen.network>
* Update beginblock-endblock.md
* Update docs/core/baseapp.md
Co-authored-by: Aaron Craelius <aaron@regen.network>
* Update docs/core/transactions.md
Co-authored-by: Aaron Craelius <aaron@regen.network>
* Add deprecated notice
* Update tx-lifecycle.md
Co-authored-by: Robert Zaremba <robert@zaremba.ch>
Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>
Co-authored-by: Aaron Craelius <aaron@regen.network>
Co-authored-by: Cory <cjlevinson@gmail.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2020-11-17 20:41:43 +00:00
Ryan Christoffersen
Robert Zaremba
Ryan Christoffersen
Cyrus Goh
Rikard Hjort
Pash
Amaury
Marie Gauthier