Commit Graph

8 Commits

Author SHA1 Message Date
Julien Robert e7066c4271
docs: Code blocks in SDK docs are broken (#11189) 2022-02-14 23:39:35 +01:00
Julien Robert 58597139fa
docs: Improve markdownlint configuration (#11104)
## Description

Closes: #9404



---

### Author Checklist

*All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.*

I have...

- [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [x] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [x] reviewed "Files changed" and left comments if necessary
- [x] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed 
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
2022-02-10 12:07:01 +00:00
Brenn Hill a47bd592e9
docs: 10180 Fix SDK (#10237)
* docs: Fix Cosmos-sdk references in md files

* Fix SDK to Cosmos SDK in all found places and adjust grammar in turn

* Add changelog entry

* Update docs/core/context.md

Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>

* Update docs/architecture/adr-010-modular-antehandler.md

Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>

* Update docs/basics/README.md

Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>

* Update docs/architecture/adr-040-storage-and-smt-state-commitments.md

Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>

* Update docs/building-modules/intro.md

Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>

* Update docs/building-modules/intro.md

Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>

* Update docs/core/baseapp.md

Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>

* Update docs/building-modules/intro.md

Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>

* Update docs/basics/accounts.md

Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>

* docs 10180 fix 'an Cosmos SDK' where used

Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>
Co-authored-by: Robert Zaremba <robert@zaremba.ch>
2021-09-28 19:33:58 +02:00
Ryan Christoffersen 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
Cory 308ee267a8
Followup suggestions from ADR-027 updates (#7232) (#7379)
* add grammar suggestions to adr-027

* Update docs/architecture/adr-027-deterministic-protobuf-serialization.md

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2020-09-28 09:42:57 +00:00
Robert Zaremba 09998ef86e
adr-27: adding (#7232)
* adr-27: adding 

Each ADR should have an abstract and an example use case to quickly present the goal.
Here, adding this to DR 027: Deterministic Protobuf Serialization

* review update

* added link to TxRaw

* added list of major use-cases

* updated wording in context and abstract

* updated the adr-020 part

* add consequences and motivation for TxRaw

* Update docs/architecture/adr-027-deterministic-protobuf-serialization.md

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>

* Update docs/architecture/adr-027-deterministic-protobuf-serialization.md

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>

* Update docs/architecture/adr-027-deterministic-protobuf-serialization.md

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>

* Update docs/architecture/adr-027-deterministic-protobuf-serialization.md

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>

* Update docs/architecture/adr-027-deterministic-protobuf-serialization.md

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>

* rewording

* Update docs/architecture/adr-027-deterministic-protobuf-serialization.md

Co-authored-by: Simon Warta <2603011+webmaster128@users.noreply.github.com>

* Update docs/architecture/adr-027-deterministic-protobuf-serialization.md

Co-authored-by: Simon Warta <2603011+webmaster128@users.noreply.github.com>

* Update docs/architecture/adr-027-deterministic-protobuf-serialization.md

Co-authored-by: Simon Warta <2603011+webmaster128@users.noreply.github.com>

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>
Co-authored-by: Simon Warta <2603011+webmaster128@users.noreply.github.com>
Co-authored-by: Cory <cjlevinson@gmail.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2020-09-23 23:06:55 +00:00
John Adler 2bb9a241bb
ADR-027: Make rules more precise (#7220)
* Update changelog.

* Fix typos.

* Remove 'by default' from packed encoding rule.

* Further specify longer requirement.

* Clarify that bool must have value of 1 if included.

* Fix typo variant -> varint.

* Disambiguate rule 3.

* Add more reasoning for requirements on zeroes.

* Reword rules to make bit restrictions clearer. Add exception for negative int32.

* Add reference for signed integer encoding.

* Clarify rule for signed int requirement.

* Deterministic -> bijective.

* Normalize spacing in 'protobuf 3'.

* Add background to clarify 70 bits.

* Fix nit: all -> most.

* Clarify is -> must.

Co-authored-by: Alessio Treglia <alessio@tendermint.com>
2020-09-11 14:46:37 +00:00
Simon Warta 1b9f144b9d
Propose ADR 027: Deterministic Protobuf Serialization (#6979)
* Add ADR 026: Protocol Buffer Regencode

* Use Regencode in ADR-020

* Apply suggestions from code review

Co-authored-by: Aaron Craelius <aaron@regen.network>

* Add reasoning behind omitting empty fields

* Rename to ADR 026: Deterministic Protobuf Serialization

* i++

* explicitely -> explicitly

* Fix description of optional values

* Update reasoning behind omitting default values

* Fix empty -> defaut

* Update docs/architecture/adr-027-deterministic-protobuf-serialization.md

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>

* Add rules to avoid duplicate encoding and specify packed fields

* Add rule for variant encoding

* Add surrogate pair to test UTF-8 encoding

Co-authored-by: Aaron Craelius <aaron@regen.network>
Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>
2020-08-19 17:22:15 +00:00