diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml index b74b2cee9..c08eafd20 100644 --- a/.github/workflows/codespell.yml +++ b/.github/workflows/codespell.yml @@ -25,4 +25,4 @@ jobs: run: pip install codespell - name: Run codespell - run: codespell --skip="yarn.lock,package-lock.json,node_modules,build" + run: codespell --skip="yarn.lock,package-lock.json,node_modules,build" --ignore-words=".codespellignore" diff --git a/docs/frontend/README.mdx b/docs/frontend/README.mdx index 8a9f70c63..06810dc26 100644 --- a/docs/frontend/README.mdx +++ b/docs/frontend/README.mdx @@ -76,7 +76,7 @@ The following are libraries and utilities to start developing with Osmosis. diff --git a/docs/osmosis-outpost/README.md b/docs/osmosis-outpost/README.md index 6ba0e5573..8afb2d8f2 100644 --- a/docs/osmosis-outpost/README.md +++ b/docs/osmosis-outpost/README.md @@ -18,18 +18,18 @@ provides a set of **components** and **templates** to allow any enabled chain to realize its own *frontend outpost*. If you want to create your own outpost platform, please follow the instruction -available at the [Introduction page](./user-interface-setup/introduction). +available at the [Introduction page](/osmosis-outpost/user-interface-setup/introduction). ### 📡 Stay tuned If you have integrated the platform, please let us know so we can share the news with our community! Moreover, to stay updated with any changes or new features, -please follow us. You can find how to reach us [here](../../contact). +please follow us. You can find how to reach us [here](/osmosis-outpost/contact). ### 📖 User guide We realized a set of **tutorial** to follow your users step by step on *how to* *perform a swap* and *how to troubleshoot some common issues*. You can find it -[here](../user-guide/how-to-do-a-swap). +[here](/osmosis-outpost/user-guide/how-to-do-a-swap). ### 📞 Support Once you have integrated the widget, or created your new platform application, @@ -38,4 +38,4 @@ troubleshoot issues that users may encounter while using the widget or the app. If you, or your users, discover any **issues or errors** while using the platform, please *reach us* through the channels available -[here](../../contact). +[here](/osmosis-outpost/contact). diff --git a/docs/osmosis-outpost/user-interface-setup/frontend-platform-interface/customization-guide/design-customization.md b/docs/osmosis-outpost/user-interface-setup/frontend-platform-interface/customization-guide/design-customization.md index 32876b147..53e53449d 100644 --- a/docs/osmosis-outpost/user-interface-setup/frontend-platform-interface/customization-guide/design-customization.md +++ b/docs/osmosis-outpost/user-interface-setup/frontend-platform-interface/customization-guide/design-customization.md @@ -16,11 +16,11 @@ design version of the platform by simply editing the colours, label and logo. The result of a such a process, will give you a design showing what you will get if you follow the instructions on the -[customization guide](./customization/customizations) creating a code +[customization guide](./customization/code-customization.md) creating a code implementation associated to the colours code you set on the Figma file. To better understand how the color are linked to the elements in the platform, -please give a look at the [Theme Customization](./theme-customization) page. +please give a look at the [Theme Customization](./theme-customization.md) page. ### 1. Duplicate the Figma file Click on the @@ -117,4 +117,4 @@ Please, access this page in dark mode to have a better experience. And... you are done! Now to enjoy the results of your efforts, you can reach the "Frontend Platform Interface" page and see the mockup you realized!! -![Enjoy the result image](/img/user-interface-setup/frontend-platform-interface/design-customization/12.jpg "enjoy the result") \ No newline at end of file +![Enjoy the result image](/img/user-interface-setup/frontend-platform-interface/design-customization/12.jpg "enjoy the result") diff --git a/docs/overview/endpoints/index.mdx b/docs/overview/endpoints/index.mdx index b669c2bfe..08f0c2ee4 100644 --- a/docs/overview/endpoints/index.mdx +++ b/docs/overview/endpoints/index.mdx @@ -24,7 +24,7 @@ This section serves the purpose of different endpoints for different projects on These following API's are recommended for development purposes. For maximum control and reliability it's recommended to run your own node. This can be easility accomplsihed by using the get.osmosis.zone installer. -- gRPC endpoint: [grpc.osmosis.zone:9090](grpc.osmosis.zone:9090) +- gRPC endpoint: [grpc.osmosis.zone:9090](https://grpc.osmosis.zone:9090) - gRPC-gateway: [https://rpc.osmosis.zone:443](https://rpc.osmosis.zone:443) - lcd-endpoint: [https://lcd.osmosis.zone](https://lcd.osmosis.zone) @@ -34,12 +34,12 @@ Swagger for RPC and LCD: Please visit [API Playground](/api) for more docs and to try interacting with these endpoints. -For more information how to integrate with each endpoints, please refer to the [integrate section](../integrate) +For more information how to integrate with each endpoints, please refer to the [Integrate section](../overview/integrate). ## Historical Data / Indexed Data Osmosis keeps indexed chain data in a separate endpoint: -- [api.osmosis.zone](api.osmosis.zone) +- [api.osmosis.zone](https://api.osmosis.zone) This endpoint provides processed data such as: - [historical token price chart](https://api-osmosis.imperator.co/swagger/#/tokens/token_price_historical_chart_v2) diff --git a/docs/overview/integrate/cli.md b/docs/overview/integrate/cli.md index cfb68d061..93b35f9b2 100644 --- a/docs/overview/integrate/cli.md +++ b/docs/overview/integrate/cli.md @@ -6,7 +6,7 @@ sidebar_position: 9 ## Using the CLI -Once osmosisd is [installed](../osmosis-core/osmosisd) and configured with the correct network, you can now send commands with it. In a new terminal window, start by running the following query command: +Once osmosisd is [installed](../../osmosis-core/osmosisd) and configured with the correct network, you can now send commands with it. In a new terminal window, start by running the following query command: ### Node status ```bash @@ -77,7 +77,7 @@ Output: "grpc-concurrency": false } ``` -In this example when we install osmosisd as a client with the [installer](../osmosis-core/osmosisd), it connects to the `http://osmosis.artifact-staking.io:26657`. +In this example when we install osmosisd as a client with the [installer](../../osmosis-core/osmosisd), it connects to the `http://osmosis.artifact-staking.io:26657`. ### Change node diff --git a/docs/overview/integrate/grpc.md b/docs/overview/integrate/grpc.md index e889857d0..d45c67a48 100644 --- a/docs/overview/integrate/grpc.md +++ b/docs/overview/integrate/grpc.md @@ -17,7 +17,7 @@ If you are running your own node. It's also possible to enable them by editing ## Grpc endpoints An overview of all available gRPC endpoints shipped with Osmosis is available in the [Osmosis Protobuf documentation](https://buf.build/osmosis-labs/osmosis). There is also a Cosmos SDK is [Protobuf documentation](https://buf.build/cosmos/cosmos-sdk). -You can send requests to the gRPC server using a gRPC client such as [grpcurl](#grpcurl) or from [Buf Studio](./interact-grpc-buf-studio). +You can send requests to the gRPC server using a gRPC client such as [grpcurl](#grpcurl) or from [Buf Studio](#buf-studio). Since the code generation library largely depends on your own tech stack, we will only present three alternatives: @@ -51,7 +51,7 @@ We have a Buf agent running at https://buf.osmosis.zone which will allow you to [grpcurl](https://github.com/fullstorydev/grpcurl) is like `curl` but for gRPC. It is also available as a Go library, but we will use it only as a CLI command for debugging and testing purposes. Follow the instructions in the previous link to install it. -Assuming you already installed osmosisd with the [installer](../osmosis-core/osmosisd), you should be able to run the following command to list the Protobuf services available (you can replace `grpc.osmosis.zone:9000` by the gRPC server endpoint of another node such as the testnet, another provider or your own node. +Assuming you already installed osmosisd with the [installer](../../osmosis-core/osmosisd), you should be able to run the following command to list the Protobuf services available (you can replace `grpc.osmosis.zone:9000` by the gRPC server endpoint of another node such as the testnet, another provider or your own node. Listing all the methods from the mainnet @@ -230,4 +230,4 @@ func queryState() error { return nil } -``` \ No newline at end of file +``` diff --git a/docs/overview/validate/joining-mainnet.md b/docs/overview/validate/joining-mainnet.md index c3621b64b..93d07a04a 100644 --- a/docs/overview/validate/joining-mainnet.md +++ b/docs/overview/validate/joining-mainnet.md @@ -19,7 +19,7 @@ curl -sL https://get.osmosis.zone/install > i.py && python3 i.py ## Or Install Osmosis Binary manually -Make sure you have [installed the Osmosis Binary CLI](../osmosis-core/osmosisd#minimum-requirements) prior to following the below instructions. +Make sure you have [installed the Osmosis Binary CLI](../../osmosis-core/osmosisd#minimum-requirements) prior to following the below instructions. ## Initialize Osmosis Node @@ -276,4 +276,4 @@ git pull git checkout v10.0.0 make build cp build/osmosisd ~/.osmosisd/cosmovisor/upgrades/v9/bin -``` \ No newline at end of file +``` diff --git a/docs/overview/validate/joining-testnet.md b/docs/overview/validate/joining-testnet.md index b2394410d..e0160e277 100644 --- a/docs/overview/validate/joining-testnet.md +++ b/docs/overview/validate/joining-testnet.md @@ -17,9 +17,9 @@ curl -sL https://get.osmosis.zone/install > i.py && python3 i.py ## Osmosis CLI -Make sure you have [installed the Osmosis Binary (CLI)](../osmosis-core/osmosisd) prior to following the below instructions. +Make sure you have [installed the Osmosis Binary (CLI)](../../osmosis-core/osmosisd) prior to following the below instructions. -You may also [use the Osmosis installer](../osmosis-core/osmosisd) if you want everything to be done automatically. +You may also [use the Osmosis installer](../../osmosis-core/osmosisd) if you want everything to be done automatically. ## Faucet In order to get testnet tokens use [https://faucet.osmosis.zone/](https://faucet.osmosis.zone/)