Skip to content

Commit

Permalink
docs: folding module specs files into single README file (#1369)
Browse files Browse the repository at this point in the history
## Description

Following the Cosmos SDK updates, let's fold spec files into a README file, and put more specific things into the spec directory.

---

### 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...

- [ ] 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
- [ ] added appropriate labels to the PR
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/umee-network/umee/blob/main/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] reviewed "Files changed" and left comments if necessary
- [ ] 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 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)
  • Loading branch information
robert-zaremba committed Sep 13, 2022
1 parent 0afaf70 commit 6993074
Show file tree
Hide file tree
Showing 16 changed files with 338 additions and 758 deletions.
181 changes: 144 additions & 37 deletions x/leverage/spec/01_concepts.md → x/leverage/README.md

Large diffs are not rendered by default.

56 changes: 0 additions & 56 deletions x/leverage/spec/02_state.md

This file was deleted.

16 changes: 0 additions & 16 deletions x/leverage/spec/03_queries.md

This file was deleted.

120 changes: 0 additions & 120 deletions x/leverage/spec/04_messages.md

This file was deleted.

24 changes: 0 additions & 24 deletions x/leverage/spec/05_endblock.md

This file was deleted.

112 changes: 0 additions & 112 deletions x/leverage/spec/06_events.md

This file was deleted.

36 changes: 0 additions & 36 deletions x/leverage/spec/07_params.md

This file was deleted.

0 comments on commit 6993074

Please sign in to comment.