Skip to content

Commit

Permalink
fix: docs typos (cosmos#5014)
Browse files Browse the repository at this point in the history
* Fix typos 01-overview.md

* Fix Typos 00-intro.md

Fixed typos & tweaked intro language

* style: raname sidebar Tutorials to Developer Portal

---------

Co-authored-by: srdtrk <srdtrk@hotmail.com>
  • Loading branch information
merkletreeibc and srdtrk authored Nov 3, 2023
1 parent 0d55fe1 commit fec07ec
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 13 deletions.
6 changes: 3 additions & 3 deletions docs/docs/00-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ sidebar_position: 0

Welcome to the documentation for IBC-Go, the Golang implementation of the Inter-Blockchain Communication Protocol! Looking for information on ibc-rs? [Click here to go to the ibc-rs github repo](https://github.com/cosmos/ibc-rs).

The Inter-Blockchain Communication protocol (IBC) is an end-to-end, connection-oriented, stateful protocol for reliable, ordered, and authenticated communication between heterogeneous blockchains arranged in an unknown and dynamic topology.
The Inter-Blockchain Communication Protocol (IBC) is an end-to-end, connection-oriented, stateful protocol for reliable, ordered, and authenticated communication between heterogeneous blockchains arranged in an unknown and dynamic topology.

IBC is a protocol that allows blockchains to talk to each other. Chains that speak IBC can share arbitrary data, enabling the industry’s most feature-rich cross-chain interactions. IBC is secure and permissionless.
IBC is a protocol that allows blockchains to talk to each other. Chains that speak IBC can share any type of data as long as it's encoded in bytes, enabling the industry’s most feature-rich cross-chain interactions. IBC is secure and permissionless.

The protocol realizes this interoperability by specifying a set of data structures, abstractions, and semantics that can be implemented by any distributed ledger that satisfies a small set of requirements.

IBC can be used to build a wide range of cross-chain applications that include token transfers, atomic swaps, multi-chain smart contracts (with or without mutually comprehensible VMs), and data and code sharding of various kinds.
IBC can be used to build a wide range of cross-chain applications that include token transfers, atomic swaps, multi-chain smart contracts (with or without mutually comprehensible VMs), cross-chain account control, and data and code sharding of various kinds.
10 changes: 5 additions & 5 deletions docs/docs/01-ibc/01-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,23 @@ slug: /ibc/overview
# Overview

:::note Synopsis
Learn about IBC, its components, and IBC use cases.
Learn about IBC, its components, and its use cases.
:::

## What is the Interblockchain Communication Protocol (IBC)?
## What is the Inter-Blockchain Communication Protocol (IBC)?

This document serves as a guide for developers who want to write their own Inter-Blockchain
Communication protocol (IBC) applications for custom use cases.
Communication Protocol (IBC) applications for custom use cases.

> IBC applications must be written as self-contained modules.
Due to the modular design of the IBC protocol, IBC
Due to the modular design of the IBC Protocol, IBC
application developers do not need to be concerned with the low-level details of clients,
connections, and proof verification.

This brief explanation of the lower levels of the
stack gives application developers a broad understanding of the IBC
protocol. Abstraction layer details for channels and ports are most relevant for application developers and describe how to define custom packets and `IBCModule` callbacks.
Protocol. Abstraction layer details for channels and ports are most relevant for application developers and describe how to define custom packets and `IBCModule` callbacks.

The requirements to have your module interact over IBC are:

Expand Down
2 changes: 1 addition & 1 deletion docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ const sidebars = {
},
{
type: "link",
label: "Tutorials",
label: "Developer Portal",
href: "https://tutorials.cosmos.network",
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_sidebars/version-v4.4.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
},
{
"type": "link",
"label": "Tutorials",
"label": "Developer Portal",
"href": "https://tutorials.cosmos.network"
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_sidebars/version-v5.3.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
},
{
"type": "link",
"label": "Tutorials",
"label": "Developer Portal",
"href": "https://tutorials.cosmos.network"
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_sidebars/version-v6.2.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
},
{
"type": "link",
"label": "Tutorials",
"label": "Developer Portal",
"href": "https://tutorials.cosmos.network"
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_sidebars/version-v7.3.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
},
{
"type": "link",
"label": "Tutorials",
"label": "Developer Portal",
"href": "https://tutorials.cosmos.network"
},
{
Expand Down

0 comments on commit fec07ec

Please sign in to comment.