Skip to content

Commit 4448914

Browse files
Merge pull request #287 from JeremyParish69/update-docs
Update Docs Typos and Broken Links
2 parents ce8521c + d06820e commit 4448914

File tree

18 files changed

+25
-25
lines changed

18 files changed

+25
-25
lines changed

.codespellignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
amountIn

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
## What is the purpose of the change
2323

24-
*(For example: This pull request improves documation of area A by adding ....*
24+
*(For example: This pull request improves documentation of area A by adding ....*
2525

2626

2727
## Brief change log

docs/frontend/README.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ The following are libraries and utilities to start developing with Osmosis.
7676
<Card
7777
title="Cosmos Kit"
7878
description="A wallet adapter for react with mobile WalletConnect support for the Cosmos ecosystem."
79-
to="cosmos-kit"
79+
to="/cosmos-kit"
8080
icon=""
8181
svgFile="/icons/bag.svg"
8282
/>

docs/frontend/cosmos-kit.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ CosmosKit is a wallet adapter for developers to build apps that quickly and easi
44

55
## Getting Started
66

7-
To get started with CosmosKit, follow the [How to use CosmosKit](https://docs.cosmoskit.com/get-started) guide.
7+
To get started with CosmosKit, follow the [How to use CosmosKit](https://docs.hyperweb.io/cosmos-kit/get-started) guide.
88

99
## Examples
1010

@@ -46,4 +46,4 @@ If you're a wallet developer and want to integrate new wallets into CosmosKit, f
4646
- [Official Website](https://cosmoskit.com/) (in progress)
4747
- [Cosmos SDK Documentation](https://docs.cosmos.network/)
4848

49-
Please refer to the [CosmosKit documentation](https://docs.cosmoskit.com) for more information and detailed guides.
49+
Please refer to the [CosmosKit documentation](https://docs.cosmoskit.com) for more information and detailed guides.

docs/osmosis-core/localtesting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ LocalOsmosis has the following advantages over a public testnet:
2626
- [`docker-compose`](https://github.com/docker/compose)
2727
- [`Osmosisd`](https://get.osmosis.zone)
2828
* Select option 3 (localosmosis), the installer will configure everything for you.
29-
* The osmosisd dameon on your local computer is used to communicate with the localosmosis daemin running inside the Docker container.
29+
* The osmosisd daemon on your local computer is used to communicate with the localosmosis daemon running inside the Docker container.
3030
- Supported known architecture: x86_64
3131
- 16+ GB of RAM is recommended
3232

@@ -141,4 +141,4 @@ LocalOsmosis is pre-configured with one validator and 9 accounts with ION and OS
141141
| lo-test7 | `osmo10qfrpash5g2vk3hppvu45x0g860czur8ff5yx0` | `noble width taxi input there patrol clown public spell aunt wish punch moment will misery eight excess arena pen turtle minimum grain vague inmate` |
142142
| lo-test8 | `osmo1f4tvsdukfwh6s9swrc24gkuz23tp8pd3e9r5fa` | `cream sport mango believe inhale text fish rely elegant below earth april wall rug ritual blossom cherry detail length blind digital proof identify ride` |
143143
| lo-test9 | `osmo1myv43sqgnj5sm4zl98ftl45af9cfzk7nhjxjqh` | `index light average senior silent limit usual local involve delay update rack cause inmate wall render magnet common feature laundry exact casual resource hundred` |
144-
| lo-test10 | `osmo14gs9zqh8m49yy9kscjqu9h72exyf295afg6kgk` | `prefer forget visit mistake mixture feel eyebrow autumn shop pair address airport diesel street pass vague innocent poem method awful require hurry unhappy shoulder` |
144+
| lo-test10 | `osmo14gs9zqh8m49yy9kscjqu9h72exyf295afg6kgk` | `prefer forget visit mistake mixture feel eyebrow autumn shop pair address airport diesel street pass vague innocent poem method awful require hurry unhappy shoulder` |

docs/osmosis-core/relaying/ibc-relayers-list.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ sidebar_position: 4
77
| Relayer | Contact | How to Support | Support for new relayers | Chains Relaying with Osmosis |
88
| -------- | -------- | --- | --- | --- |
99
| [3ventures.io](https://www.3ventures.io/) | [email protected] <br/> <img src="https://user-images.githubusercontent.com/95667791/163506878-e7e278b2-1cf6-4dac-bc13-e92f63600ee0.png" alt="Twitter" width="18"/> Twitter [@3venturesio](https://twitter.com/3venturesio) <br/> <img src="https://user-images.githubusercontent.com/95667791/163505650-fe08f2a7-8419-4a2f-97b7-e5182dd386e1.png" alt="Discord" width="18"/> Discord 3venturesio#8876 <br/> <img src="https://user-images.githubusercontent.com/95667791/163506639-7d27e947-94c7-4740-bb46-8e5791e9fc6c.png" alt="Telegram" width="18"/> Telegram [Threeventures chat](https://t.me/threeventures), @ossca, @ElonMuscleMoon, @VitalikButter | :lock: Delegate to 3ventures.io on: Chihuahua, Stargaze, Deweb, Axelar, Gravity Bridge, Umee, Comdex, Evmos <br/> :pray: Donations accepted @ <sup><sub>`osmo1mlzgx9zsncyrhzl23w9dt6c9zphsx5h87033xz`</sub></sup> | :information_desk_person: Supports new relayers | Umee, Stargaze, Gravity Bridge, Chihuahua, Comdex, Evmos |
10-
| [BlockNgine](https://blockngine.io/) | [email protected] <br/> <img src="https://user-images.githubusercontent.com/95667791/163506878-e7e278b2-1cf6-4dac-bc13-e92f63600ee0.png" alt="Twitter" width="18"/> Twitter [@BlockNgine](https://twitter.com/BlockNgine) <br/> <img src="https://user-images.githubusercontent.com/95667791/163505650-fe08f2a7-8419-4a2f-97b7-e5182dd386e1.png" alt="Discord" width="18"/> Discord BlockNgine#7943 <br/> <img src="https://user-images.githubusercontent.com/95667791/163506639-7d27e947-94c7-4740-bb46-8e5791e9fc6c.png" alt="Telegram" width="18"/> Telegram [BlockNgine chat](https://t.me/BlockNgine), @NGINE | :lock: Delegate to BlockNgine on: [Osmosis](https://wallet.keplr.app/#/osmosis/stake?modal=detail&chainId=osmosis-1&validator=osmovaloper1pxphtfhqnx9ny27d53z4052e3r76e7qq495ehm), Cardano, Terra, Sifchain, Injective, Osmosis, Secret, Harmony, Kava, Band, Mina, Akash, Sentinel, Comdex, e-Money, Odin, Konstellation <br/> :pray: Donations accepted @ <sup><sub>`osmo1a0q8rqxy9npr3hysrammsegrxwekuamwdf8gy8`</sub></sup> | :heavy_dollar_sign: Offers Relaying as a Service (RaaS) (contact directly for pricing) <br/> :information_desk_person: Supports new relayers | Secret, Akash, Kava, Comdex |
1110
| [Blockscope](https://blockscope.net/) | [email protected] <br/> <img src="https://user-images.githubusercontent.com/95667791/163505650-fe08f2a7-8419-4a2f-97b7-e5182dd386e1.png" alt="Discord" width="18"/> Discord feida \| Blockscope.net#8484 <br/> <img src="https://user-images.githubusercontent.com/95667791/163506639-7d27e947-94c7-4740-bb46-8e5791e9fc6c.png" alt="Telegram" width="18"/> Telegram [Blockscope Group](https://t.me/joinchat/fQpJZhQzpaRkOGE0) | :lock: Delegate to Blockscope.net on: Gravity Bridge, Umee, AssetMantle, Fetch.ai, OmniFlix, Ixo, Ki, BitCanna, Crescent, Chronic, Galaxy <br/> :pray: Donations accepted @ <sup><sub>`osmo1exmqgkjw5wv099ce906n0w08jp7xrgjzynzm8u`</sub></sup> | :heavy_dollar_sign: Offers Relaying as a Service (RaaS) (contact directly for pricing) <br/> :information_desk_person: Supports new relayers | Cosmos Hub, Gravity Bridge, Umee, AssetMantle, Fetch.ai, OmniFlix, Galaxy, Ixo, Ki, BitCanna |
1211
| [BloClick](https://bloclick.com/) | [email protected] <br/> <img src="https://user-images.githubusercontent.com/95667791/163505650-fe08f2a7-8419-4a2f-97b7-e5182dd386e1.png" alt="Discord" width="18"/> Discord ivandiazperez#5927 | :lock: Delegate to BloClick on: Ixo, Fetch.ai, Bitcanna, Regen, AssetMantle, Desmos, Stargaze, OmniFlix, Gravity Bridge, Chronic, Umee | :heavy_dollar_sign: Offers Relaying as a Service (RaaS) (contact directly for pricing) <br/> :information_desk_person: Supports new relayers | OmniFlix, Stargaze |
1312
| [Bro_n_Bro](https://monitor.bronbro.io/) | <img src="https://user-images.githubusercontent.com/95667791/163506878-e7e278b2-1cf6-4dac-bc13-e92f63600ee0.png" alt="Twitter" width="18"/> Twitter [@bro_n_bro](https://twitter.com/Bro_n_Bro) <br/> <img src="https://user-images.githubusercontent.com/95667791/163506639-7d27e947-94c7-4740-bb46-8e5791e9fc6c.png" alt="Telegram" width="18"/> Telegram [Bro_n_Bro chat](https://t.me/bro_n_bro_community) | :lock: Delegate to Bro_n_Bro on: [Osmosis](https://wallet.keplr.app/#/osmosis/stake?modal=detail&chainId=osmosis-1&validator=osmovaloper13tk45jkxgf7w0nxquup3suwaz2tx483xe832ge), Bostrom, Osmo, e-Money, Juno, Stars, Microtick, Gravity, OmniFlix, Evmos | :information_desk_person: Supports new relayers | Bostrom |
@@ -27,5 +26,5 @@ sidebar_position: 4
2726
| [StakeLab](https://www.stakelab.fr/) | [email protected] <br/> <img src="https://user-images.githubusercontent.com/95667791/163506878-e7e278b2-1cf6-4dac-bc13-e92f63600ee0.png" alt="Twitter" width="18"/> Twitter [@StakeLab](https://twitter.com/StakeLab) <br/> <img src="https://user-images.githubusercontent.com/95667791/163506639-7d27e947-94c7-4740-bb46-8e5791e9fc6c.png" alt="Telegram" width="18"/> Telegram [StakeLab chat](https://t.me/stakelab_fr) | :lock: Delegate to StakeLab on: [Osmosis](https://wallet.keplr.app/#/osmosis/stake?modal=detail&chainId=osmosis-1&validator=osmovaloper16q8xd335y38xk2ul67mjg27vdnrcnklt4wx6kt), Akash, Asset Mantle, Axelar, Band Protocol, Bitcanna, Bitsong, Cerberus, Certik, Chihuahua, Comdex, Cosmos Hub, Decentr, Desmos, Dig Chain, E-money, Evmos, Fetch Ai, Galaxy, Gravity Bridge, Injective, Iris, Ixo, Juno, Kava, Ki Chain, Konstellation, Lum, Medibloc, Meme, Microtick, Nomic, Omniflix, Osmosis, Persistence, Regen, Rizon, Secret, Sentinel, Sifchain, Sommelier, Stargaze, Starname, Terra, Umee, Vidulum | :information_desk_person: Supports new relayers | Almost all our blockchains supported |
2827
| [strangelove-ventures](https://www.strangelove.ventures/) | <img src="https://user-images.githubusercontent.com/95667791/163506878-e7e278b2-1cf6-4dac-bc13-e92f63600ee0.png" alt="Twitter" width="18"/> Twitter [@strangelovefund](https://twitter.com/strangelovefund), [@jack_zampolin](https://twitter.com/jack_zampolin), [@Etheral0ne](https://twitter.com/Ethereal0ne) | :lock: Delegate to strangelove-ventures on: [Osmosis](https://wallet.keplr.app/#/osmosis/stake?modal=detail&chainId=osmosis-1&validator=osmo1r2u5q6t6w0wssrk6l66n3t2q3dw2uqny0l6fwk), Cosmos Hub, Akash, Axelar, Crescent, Sentinel, OmniFlix <br/> :pray: Donations accepted @ <sup><sub>`osmo1r2u5q6t6w0wssrk6l66n3t2q3dw2uqny0l6fwk`</sub></sup> | :heavy_dollar_sign: Offers Relaying as a Service (RaaS) (contact directly for pricing) <br/> :information_desk_person: Supports new relayers | Cosmos Hub, Juno, Axelar, Sommelier |
2928
| [Witval](http://Vitwit.com) | [email protected] <br/> <img src="https://user-images.githubusercontent.com/95667791/163506878-e7e278b2-1cf6-4dac-bc13-e92f63600ee0.png" alt="Twitter" width="18"/> Twitter @vitwit_, @anilcse_ <br/> <img src="https://user-images.githubusercontent.com/95667791/163506639-7d27e947-94c7-4740-bb46-8e5791e9fc6c.png" alt="Telegram" width="18"/> Telegram @anilcse | :lock: Delegate to Witval on: [Osmosis](https://wallet.keplr.app/#/osmosis/stake?modal=detail&chainId=osmosis-1&validator=osmovaloper1ddle9tczl87gsvmeva3c48nenyng4n56yscals), Cosmos Hub, Regen, Akash, Desmos, Juno, Stargaze, Gravity Bridge, Evmos, Agoric, Comdex, e-Money, OmniFlix, Persistence, Sentinel | :heavy_dollar_sign: Offers Relaying as a Service (RaaS) (contact directly for pricing) <br/> :information_desk_person: Supports new relayers | Cosmos Hub, Regen, Akash, Juno, Persistence, Comdex, Sentinel, Stargaze, Gravity Bridge, Provenance |
30-
| [Crypto Assassin] | [email protected] <br/> <img src="https://user-images.githubusercontent.com/95667791/163506878-e7e278b2-1cf6-4dac-bc13-e92f63600ee0.png" alt="Twitter" width="18"/> Twitter [@CryptoAssassi11](https://twitter.com/CryptoAssassi11) <br/> <img src="https://user-images.githubusercontent.com/95667791/163505650-fe08f2a7-8419-4a2f-97b7-e5182dd386e1.png" alt="Discord" width="18"/> Discord: Crypto Assassin#8752 <br/> <img src="https://user-images.githubusercontent.com/95667791/163506639-7d27e947-94c7-4740-bb46-8e5791e9fc6c.png" alt="Telegram" width="18"/> Telegram @Khuwarzmi | :lock: Delegate to Crypto Assassin on: [Osmosis](https://wallet.keplr.app/#/osmosis/stake?modal=detail&chainId=osmosis-1&validator=osmovaloper1f6wx6r7567wu5j4ysskshkmsrk29sme97x25ca), Chihuahua | :information_desk_person: Supports new relayers |
29+
| Crypto Assassin | [email protected] <br/> <img src="https://user-images.githubusercontent.com/95667791/163506878-e7e278b2-1cf6-4dac-bc13-e92f63600ee0.png" alt="Twitter" width="18"/> Twitter [@CryptoAssassi11](https://twitter.com/CryptoAssassi11) <br/> <img src="https://user-images.githubusercontent.com/95667791/163505650-fe08f2a7-8419-4a2f-97b7-e5182dd386e1.png" alt="Discord" width="18"/> Discord: Crypto Assassin#8752 <br/> <img src="https://user-images.githubusercontent.com/95667791/163506639-7d27e947-94c7-4740-bb46-8e5791e9fc6c.png" alt="Telegram" width="18"/> Telegram @Khuwarzmi | :lock: Delegate to Crypto Assassin on: [Osmosis](https://wallet.keplr.app/#/osmosis/stake?modal=detail&chainId=osmosis-1&validator=osmovaloper1f6wx6r7567wu5j4ysskshkmsrk29sme97x25ca), Chihuahua | :information_desk_person: Supports new relayers |
3130
| [Stakin](https://stakin.com) | [email protected] <br/> <img src="https://user-images.githubusercontent.com/95667791/163506878-e7e278b2-1cf6-4dac-bc13-e92f63600ee0.png" alt="Twitter" width="18"/> Twitter [@StakinOfficial](https://x.com/StakinOfficial) <br/> | :lock: Delegate to Stakin on: Celestia, Saga, Sei, Cosmos Hub, Axelar, Zetachain, Terra, Agoric, Akash, Persistence, Shentu, Iris, UX <br/> | :heavy_dollar_sign: Offers Relaying as a Service (RaaS) (contact directly for pricing) <br/> :information_desk_person: Supports new relayers | Agoric, Akash, Archway, Axelar, Celestia, Cosmos Hub, Cronos PoS, Iris, Persistence, UX |

docs/osmosis-outpost/user-interface-setup/widget/embed/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ on a NextJS or a React application:
3838

3939
> **_NOTE_:** To get an example of a dApp embedding the widget, please give a
4040
> look to our
41-
> [Frontend Platform Interface documentation](../frontend-platform-interface/getting-started.md).
41+
> [Frontend Platform Interface documentation](../../frontend-platform-interface/getting-started.md).

docs/overview/educate/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ sidebar_position: 3
33
---
44
# Getting Started
55
## Set up a Wallet
6-
Before opening the Osmosis AMM App, make sure to install the [Keplr Wallet](wallets/keplr/README.md).
6+
Before opening the Osmosis AMM App, make sure to install a wallet such as [Keplr Wallet](https://www.keplr.app/).
77

88
## Open the App
99
Go to [https://app.osmosis.zone/](https://app.osmosis.zone/)

docs/overview/educate/osmosis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ As IBC continues to explode – with more than 50 blockchains connected and doze
88

99
![](../../assets/welcome.png)
1010

11-
The [Osmosis Ecosystem](https://osmosis.zone/ecosystem) is a suite of premier, DAO-gated dApps that are tightly integrated into the Osmosis AMMs and IBC routing capabilities. Dozens of developer teams are building index tokens, options, perps, stops and limit orders, automated trading, yield vaults, NFTs, and more.
11+
The [Osmosis Zone Apps Page](https://app.osmosis.zone/apps) is a suite of dApps that are tightly integrated into the Osmosis AMMs and IBC routing capabilities. Many developer teams are building index tokens, options, perps, stops and limit orders, automated trading, yield vaults, NFTs, and more.
1212
With new apps and features like stableswap, concentrated liquidity, rate-limiting, in-protocol MEV capture, and more going live all the time, Osmosis is continuing to expand its moat as the only full-service, cross-chain exchange and DeFi hub, one that rivals the smooth user experience of a CEX without compromising on the benefits of decentralized finance – self-custody, trust-minimized transactions, direct on-chain access, and privacy.
1313

1414

docs/overview/educate/terminology.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Use this glossary to learn about terms used in Osmosis and the Cosmos ecosystem.
88

99
## Active set
1010

11-
The top 150 validators that participate in consensus and receive rewards.
11+
The top 120 validators that participate in consensus and receive rewards.
1212

1313
## Air drops
1414

@@ -28,7 +28,7 @@ Groups of information stored on a blockchain. Each block contains transactions t
2828

2929
## Bonded validator
3030

31-
A validator in the [active set](../overview/terminology.md#active-set) participating in consensus. Bonded validators earn rewards.
31+
A validator in the [active set](../../overview/educate/terminology.md#active-set) participating in consensus. Bonded validators earn rewards.
3232

3333
## Bonding
3434

@@ -98,7 +98,7 @@ A written submission for a change or addition to the Osmosis protocol. Topics of
9898

9999
## Inactive set
100100

101-
Validators that are not in the [active set](../overview/terminology.md#active-set). These validators do not participate in consensus and do not earn rewards.
101+
Validators that are not in the [active set](../../overview/educate/terminology.md#active-set). These validators do not participate in consensus and do not earn rewards.
102102

103103
## IBC
104104

@@ -138,7 +138,7 @@ Since buying and selling from the pool changes the quantities of assets within a
138138
## Long-Term Liquidity
139139
Liquidity mining rewards tend to attract short-term “mercenary farmers” who quickly deposit and withdraw their liquidity after harvesting the yield. These farmers are only interested in the speculative value of the governance tokens that they are earning. They usually bounce between protocols in search of the best yield.
140140
Mercenary farmers often create the mirage of protocol adoption, but when these farmers leave, it results in significant liquidity volatility. Users of the AMM have difficulty executing trades without encountering slippage. Therefore, long-term liquidity is crucial to the success of an AMM.
141-
Osmosis’ design includes two mechanisms to incentivize long-term liquidity: [exit fees](../overview/getting-started.md#swap-fees) and [bonded liquidity gauges](../overview/getting-started.md#bonded-liquidity-gauges).
141+
Osmosis’ design includes two mechanisms to incentivize long-term liquidity: [exit fees](../../overview/educate/getting-started.md#swap-fees) and [bonded liquidity gauges](../../overview/educate/getting-started.md#bonded-liquidity-gauges).
142142

143143

144144
## Market swap

0 commit comments

Comments
 (0)