cosmos-sdk/docs/ibc
Barrie Byron ff590d198d
docs: add description of IBC to docs/ibc/overview.md (#10778)
## Description

now that Vega upgrade has passed and IBC is a standalone module, a clear definition of the IBC project is needed more than ever. This helpful plain language description helps visitors understand IBC. 

It's funny that I haven't submitted this fix before since I get frustrated every time I visit the [IBC Overview](https://docs.cosmos.network/master/ibc/overview.html) doc and don't find the answer to the heading question `What is the Inter-Blockchain Communication Protocol (IBC)?`

Let's add a description of IBC following that question

---

### 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
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] 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
- [ ] 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 `!` 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)
2021-12-16 10:49:54 +00:00
..
upgrades docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
README.md Remove IBC from the SDK (#8735) 2021-03-04 13:11:34 +00:00
custom.md chore: add markdownlint to lint commands (#9353) 2021-05-27 15:31:04 +00:00
integration.md docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
overview.md docs: add description of IBC to docs/ibc/overview.md (#10778) 2021-12-16 10:49:54 +00:00
proposals.md chore: add markdownlint to lint commands (#9353) 2021-05-27 15:31:04 +00:00
relayer.md docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00

README.md

IBC

This repository contains reference documentation for the IBC protocol integration and concepts:

  1. Overview
  2. Integration
  3. Customization
  4. Relayer
  5. Governance Proposals

NOTE: The IBC module has been moved to its own repository.

After reading about IBC, head on to the Building Modules documentation to learn more about the process of building modules.