cosmos-sdk/docs/architecture
Denis Fadeev 43627d0d1c
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
..
adr-002-docs-structure.md Fix typo (#5523) 2020-01-15 08:14:25 +01:00
adr-003-dynamic-capability-store.md Merge PR #5469: ADR 003 follow-up 2020-01-05 15:25:56 -05:00
adr-004-split-denomination-keys.md Merge PR #5572: ADR 004 Implementation 2020-01-30 16:31:16 -05:00
adr-006-secret-store-replacement.md Update ADR 006 (#5326) 2019-11-19 09:51:39 +00:00
adr-007-specialization-groups.md Merge PR #4827: ADR 007 / 008: Specialization Groups Abstraction / CERT Group 2019-09-30 15:05:29 -04:00
adr-008-dCERT-group.md Merge PR #4827: ADR 007 / 008: Specialization Groups Abstraction / CERT Group 2019-09-30 15:05:29 -04:00
adr-009-evidence-module.md docs: link checker (#5860) 2020-03-24 11:21:30 +01:00
adr-010-modular-antehandler.md Merge PR #5006: Modular AnteDecorator 2019-10-10 08:46:09 -04:00
adr-011-generalize-genesis-accounts.md Merge PR #5017: ADR 011: Generalize Genesis Accounts Implementation 2019-09-12 15:22:25 -04:00
adr-012-state-accessors.md Merge PR #4998: [ADR-012] - State Accessors 2019-09-30 16:17:55 -04:00
adr-013-metrics.md Update docs website (#5827) 2020-03-24 16:20:30 +00:00
adr-014-proportional-slashing.md Rename adt-014-proportional-slashing.md to adr-014-proportional-slashing.md 2020-03-10 15:27:53 -04:00
adr-015-ibc-packet-receiver.md Merge PR #5421: Refactor Error Handling 2019-12-27 12:57:54 -05:00
adr-016-validator-consensus-key-rotation.md Merge PR #5233: ADR 016: Validator consensus key rotation 2020-01-05 16:57:18 -05:00
adr-017-historical-header-module.md Merge PR #5340: ADR 17: Historical header module 2019-12-04 10:18:02 -05:00
adr-018-extendable-voting-period.md Merge PR #5459: ADR 18: Extendable Governance Voting Periods 2020-02-04 11:23:49 -05:00
adr-019-protobuf-state-encoding.md Favor marshal unmashal binare bare (#5799) 2020-03-13 19:58:43 +00:00
adr-020-protobuf-transaction-encoding.md Update docs/architecture/adr-020-protobuf-transaction-encoding.md 2020-03-16 10:48:37 -04:00
adr-template.md Merge PR #5650: ADR 019 - Protocol Buffer State Encoding 2020-02-17 17:10:54 +01:00
README.md docs: link checker (#5860) 2020-03-24 11:21:30 +01:00
readme.md~origin_master-docs Merge PR #5379: New docs V1 (merge master-docs to master) 2019-12-10 09:29:46 -05:00

order parent
false
order
false

Architecture Decision Records (ADR)

This is a location to record all high-level architecture decisions in the Cosmos-SDK.

You can read more about the ADR concept in this blog post.

An ADR should provide:

  • Context on the relevant goals and the current state
  • Proposed changes to achieve the goals
  • Summary of pros and cons
  • References
  • Changelog

Note the distinction between an ADR and a spec. The ADR provides the context, intuition, reasoning, and justification for a change in architecture, or for the architecture of something new. The spec is much more compressed and streamlined summary of everything as it stands today.

If recorded decisions turned out to be lacking, convene a discussion, record the new decisions here, and then modify the code to match.

Note the context/background should be written in the present tense.

Please add a entry below in your Pull Request for an ADR.

ADR Table of Contents