From a645f1ef1789579cc5fb91c4da41a416343664b8 Mon Sep 17 00:00:00 2001 From: Danilo Pantani Date: Thu, 8 Dec 2022 20:59:48 +0100 Subject: [PATCH] chore(CI): not check local urls for the md files (#3260) * not check local urls for the md lint checker and use local urls instead full url * remove quiet mode * replace base url for local files * fix base url for local links * fix base url * test a break link * test a break link * fix some broken links * fix bounty link * fix patterns * fix youtube link * remove unuseless / in the end of the url --- .github/workflows/md-link-checker-config.json | 11 ++++++++ .github/workflows/md-link-checker.yml | 3 +- .gitpod/readme.md | 8 +++--- contributing.md | 4 +-- docs/docs/clients/01-typescript.md | 4 +-- docs/docs/contributing/02-technical-setup.md | 4 +-- .../templates/02-tutorial-template.md | 4 +-- docs/docs/guide/02-getting-started.md | 4 +-- docs/docs/guide/05-nameservice/00-tutorial.md | 4 +-- docs/docs/guide/05-nameservice/01-init.md | 4 +-- docs/docs/guide/05-nameservice/02-messages.md | 2 +- docs/docs/guide/05-nameservice/03-types.md | 4 +-- docs/docs/guide/08-loan.md | 2 +- docs/docs/kb/07-frontend.md | 2 +- docs/readme.md | 2 +- .../version-v0.25.2/clients/01-typescript.md | 4 +-- .../contributing/02-technical-setup.md | 4 +-- .../templates/02-tutorial-template.md | 4 +-- .../guide/04-nameservice/00-tutorial.md | 8 +++--- .../guide/04-nameservice/01-init.md | 2 +- .../guide/04-nameservice/02-messages.md | 2 +- .../guide/04-nameservice/03-types.md | 2 +- .../version-v0.25.2/guide/06-loan.md | 2 +- docs/versioned_docs/version-v0.25.2/index.md | 2 +- .../version-v0.25.2/kb/00-kb.md | 2 +- .../version-v0.25.2/kb/07-frontend.md | 2 +- ignite/cmd/cmd.go | 2 +- readme.md | 28 +++++++++---------- 28 files changed, 68 insertions(+), 58 deletions(-) diff --git a/.github/workflows/md-link-checker-config.json b/.github/workflows/md-link-checker-config.json index 1299f33f48..1c5ff6e428 100644 --- a/.github/workflows/md-link-checker-config.json +++ b/.github/workflows/md-link-checker-config.json @@ -6,6 +6,9 @@ { "pattern": "^https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax" }, + { + "pattern": "^https://docs.starport.network" + }, { "pattern": "^http://localhost" }, @@ -13,6 +16,14 @@ "pattern": "^index.md" } ], + "replacementPatterns": [ + { + "pattern": "^/", + "replacement": "https://docs.ignite.com/" + } + ], + "baseUrl": "https://docs.ignite.com", + "projectBaseUrl": "https://docs.ignite.com", "timeout": "20s", "retryOn429": true, "retryCount": 5, diff --git a/.github/workflows/md-link-checker.yml b/.github/workflows/md-link-checker.yml index 3721c3988e..5e716d8311 100644 --- a/.github/workflows/md-link-checker.yml +++ b/.github/workflows/md-link-checker.yml @@ -7,7 +7,6 @@ jobs: - uses: actions/checkout@v3.1.0 - uses: gaurav-nelson/github-action-markdown-link-check@1.0.13 with: - folder-path: "docs" - use-quiet-mode: 'yes' + folder-path: "." use-verbose-mode: 'yes' config-file: '.github/workflows/md-link-checker-config.json' \ No newline at end of file diff --git a/.gitpod/readme.md b/.gitpod/readme.md index 7408b309a1..3503c1fd98 100644 --- a/.gitpod/readme.md +++ b/.gitpod/readme.md @@ -42,7 +42,7 @@ ignite chain serve curl https://get.ignite.com/cli | bash ``` -The latest `ignite` binary is downloaded from the project repo and installed in `/usr/local/bin`. Learn more about [installing Ignite CLI](https://docs.ignite.com/guide/install.html). +The latest `ignite` binary is downloaded from the project repo and installed in `/usr/local/bin`. Learn more about [installing Ignite CLI](https://docs.ignite.com/guide/install). ## Stay in touch @@ -54,8 +54,8 @@ Ignite CLI is a free and open source product maintained by [Ignite](https://igni * [ignite.com website](https://ignite.com) * [@ignite_dev on Twitter](https://twitter.com/ignite_dev) -* [ignite.com/blog](https://ignite.com/blog/) +* [ignite.com/blog](https://ignite.com/blog) * [Ignite Discord](https://discord.gg/ignite) -* [Ignite YouTube](https://www.youtube.com/channel/ignitehq) -* [Ignite docs](https://docs.ignite.com/) +* [Ignite YouTube](https://www.youtube.com/@ignitehq) +* [Ignite docs](https://docs.ignite.com) * [Ignite jobs](https://ignite.com/careers) diff --git a/contributing.md b/contributing.md index 9488ec4598..6cf2d02139 100644 --- a/contributing.md +++ b/contributing.md @@ -40,7 +40,7 @@ Review the issues and discussions before you open a PR. Avoid long names in your PR titles. Make sure your title has fewer than 60 characters. -Follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) guidelines and keywords to find the best +Follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0) guidelines and keywords to find the best title. Use parentheses to identify the package or feature that you worked on. For example: `feat(services/chain)` @@ -69,7 +69,7 @@ used as the commit message. When you open a PR for the Ignite CLI codebase, you must also update the relevant documentation. For changes to: * [Developer Guide](https://docs.ignite.com/guide) tutorials, update content in the `/docs/guide` folder. -* [Knowledge Base](https://docs.ignite.com/kb/), update content in the `/docs/kb` folder. +* [Knowledge Base](https://docs.ignite.com/kb), update content in the `/docs/kb` folder. * [Ignite CLI reference](https://docs.ignite.com/cli), navigate to the `./ignite/cmd` package and update the documentation of the related command from its `cobra.Command` struct. The CLI docs are automatically generated, so do not make changes to `docs/cli/index.md`. diff --git a/docs/docs/clients/01-typescript.md b/docs/docs/clients/01-typescript.md index f21a0aaded..d40055774e 100644 --- a/docs/docs/clients/01-typescript.md +++ b/docs/docs/clients/01-typescript.md @@ -32,9 +32,9 @@ ignite generate ts-client ## Setup -The best way to get started building with the TypeScript client is by using a [Vite](https://vitejs.dev/) boilerplate. +The best way to get started building with the TypeScript client is by using a [Vite](https://vitejs.dev) boilerplate. Vite provides boilerplate code for vanilla TS projects as well as react, vue, lit, svelte and preact frameworks. -You can find additional information at the [Vite Getting Started guide](https://vitejs.dev/guide/). +You can find additional information at the [Vite Getting Started guide](https://vitejs.dev/guide). You will also need to polyfill the client's dependencies. The following is an example of setting up a vanilla TS project with the necessary polyfills. diff --git a/docs/docs/contributing/02-technical-setup.md b/docs/docs/contributing/02-technical-setup.md index 4a8ecd6be2..06318465d5 100644 --- a/docs/docs/contributing/02-technical-setup.md +++ b/docs/docs/contributing/02-technical-setup.md @@ -9,7 +9,7 @@ technical setup. ## Setting up Visual Studio Code -1. Install [Visual Studio Code](https://vscode-docs.readthedocs.io/en/latest/editor/setup/). +1. Install [Visual Studio Code](https://vscode-docs.readthedocs.io/en/latest/editor/setup). 2. Click **Extensions** in the sidebar. 3. Install this extension: - Go for VS Code The official Go extension for Visual Studio Code @@ -39,7 +39,7 @@ Master your terminal to be happy. ### iTerm2 terminal emulator -On macOS, install the [iTerm2](https://iterm2.com/) OSS terminal emulator as a replacement for the default Terminal app. +On macOS, install the [iTerm2](https://iterm2.com) OSS terminal emulator as a replacement for the default Terminal app. Installing iTerm2 as a replacement for Terminal provides an updated version of the Bash shell that supports useful features like programmable completion. diff --git a/docs/docs/contributing/templates/02-tutorial-template.md b/docs/docs/contributing/templates/02-tutorial-template.md index 15ac0ea367..682380047f 100644 --- a/docs/docs/contributing/templates/02-tutorial-template.md +++ b/docs/docs/contributing/templates/02-tutorial-template.md @@ -71,9 +71,9 @@ To complete this tutorial, you will need: diff --git a/docs/docs/guide/02-getting-started.md b/docs/docs/guide/02-getting-started.md index 1cb760ca71..a9c979ef45 100644 --- a/docs/docs/guide/02-getting-started.md +++ b/docs/docs/guide/02-getting-started.md @@ -29,7 +29,7 @@ following command: ignite scaffold chain example ``` -The [`ignite scaffold chain`](https://docs.ignite.com/cli#ignite-scaffold-chain) command will create a +The [`ignite scaffold chain`](/cli#ignite-scaffold-chain) command will create a new blockchain in a new directory `example`. The new blockchain is built using the Cosmos SDK framework and imports several @@ -132,7 +132,7 @@ To start a blockchain node in development, you can run the following command: ignite chain serve ``` -The [`ignite chain serve`](https://docs.ignite.com/cli#ignite-scaffold-chain) command is used to start +The [`ignite chain serve`](/cli#ignite-scaffold-chain) command is used to start a blockchain node in development mode. It first compiles and installs the binary using the `ignite chain build` command, then initializes the blockchain's data directory for a single validator using the `ignite chain init` command. After diff --git a/docs/docs/guide/05-nameservice/00-tutorial.md b/docs/docs/guide/05-nameservice/00-tutorial.md index 25ace16bf3..3ead5a324a 100644 --- a/docs/docs/guide/05-nameservice/00-tutorial.md +++ b/docs/docs/guide/05-nameservice/00-tutorial.md @@ -49,9 +49,9 @@ blockchain app developer, you have to define the state machine with a starting state and messages that trigger state transitions. These software components make it all possible! -- [Ignite CLI](https://docs.ignite.com/) is built on top of Cosmos SDK and +- [Ignite CLI](/) is built on top of Cosmos SDK and accelerates chain development by scaffolding everything you need. -- The [Cosmos SDK](https://github.com/cosmos/cosmos-sdk/) modular framework +- The [Cosmos SDK](https://github.com/cosmos/cosmos-sdk) modular framework allows developers like you to create custom blockchains that can natively interact with other blockchains. - [Tendermint](https://docs.tendermint.com/main/introduction/what-is-tendermint.html) diff --git a/docs/docs/guide/05-nameservice/01-init.md b/docs/docs/guide/05-nameservice/01-init.md index 2e61414b64..902d00f3f2 100644 --- a/docs/docs/guide/05-nameservice/01-init.md +++ b/docs/docs/guide/05-nameservice/01-init.md @@ -12,7 +12,7 @@ so that end users can buy names and set a value to the names. ## Create a Blockchain Scaffold a new Cosmos SDK blockchain using the `ignite scaffold chain` command. -The [`ignite scaffold chain`](https://docs.ignite.com/cli#ignite-scaffold-chain) +The [`ignite scaffold chain`](/cli#ignite-scaffold-chain) command accepts one argument: the Go module path that is used for the project. By default, a chain is scaffolded with a new empty Cosmos SDK module. You want @@ -52,7 +52,7 @@ ignite scaffold module nameservice --dep bank ## Results -The [`ignite scaffold module`](https://docs.ignite.com/cli#ignite-scaffold-module) command has done all the work for you! +The [`ignite scaffold module`](/cli#ignite-scaffold-module) command has done all the work for you! - The `nameservice` module was created in the `x/nameservice` directory. - The `nameservice` module was imported into the blockchain in the `app/app.go` diff --git a/docs/docs/guide/05-nameservice/02-messages.md b/docs/docs/guide/05-nameservice/02-messages.md index 43492e10bd..243fb644ca 100644 --- a/docs/docs/guide/05-nameservice/02-messages.md +++ b/docs/docs/guide/05-nameservice/02-messages.md @@ -81,7 +81,7 @@ Use the `ignite scaffold message` command to scaffold new messages for your module. - The [`ignite scaffold - message`](https://docs.ignite.com/#ignite-scaffold-message) command accepts + message`](/cli#ignite-scaffold-message) command accepts the message name as the first argument and a list of fields for the message. - By default, a message is scaffolded in a module with a name that matches the name of the project, in this case `nameservice`. diff --git a/docs/docs/guide/05-nameservice/03-types.md b/docs/docs/guide/05-nameservice/03-types.md index b463fd8bf9..5bbdc215ab 100644 --- a/docs/docs/guide/05-nameservice/03-types.md +++ b/docs/docs/guide/05-nameservice/03-types.md @@ -16,7 +16,7 @@ For the nameservice blockchain, define a `whois` type and the create and delete methods. Because Ignite CLI does the heavy lifting for you, choose from several [ignite -scaffold](https://docs.ignite.com/cli#ignite-scaffold) commands to create CRUD +scaffold](/cli#ignite-scaffold) commands to create CRUD functionality code for data stored in different ways: - Array, a list-like data structure @@ -25,7 +25,7 @@ functionality code for data stored in different ways: ## Add the whois Type -Use the [`ignite scaffold map`](https://docs.ignite.com/cli#ignite-scaffold-map) +Use the [`ignite scaffold map`](/cli#ignite-scaffold-map) command to scaffold the `whois` type and create the code that implements CRUD functionality to create, read, update, and delete information about names. diff --git a/docs/docs/guide/08-loan.md b/docs/docs/guide/08-loan.md index 330d351129..54d0ab31f5 100644 --- a/docs/docs/guide/08-loan.md +++ b/docs/docs/guide/08-loan.md @@ -105,7 +105,7 @@ Use the `--dep` flag to specify that this module depends on and is going to inte ## Scaffold a list -Use the [scaffold list](https://docs.ignite.com/cli#ignite-scaffold-list) command to scaffold code necessary to store +Use the [scaffold list](/cli#ignite-scaffold-list) command to scaffold code necessary to store loans in an array-like data structure: ```bash diff --git a/docs/docs/kb/07-frontend.md b/docs/docs/kb/07-frontend.md index 016f60cd01..cf3db4c4c3 100644 --- a/docs/docs/kb/07-frontend.md +++ b/docs/docs/kb/07-frontend.md @@ -24,7 +24,7 @@ client: path: vue/src/store ``` -When using this configuration a TS client is generated in the `ts-client` directory (see: [TypeScript client information](https://docs.ignite.com/clients/typescript)) +When using this configuration a TS client is generated in the `ts-client` directory (see: [TypeScript client information](/clients/typescript)) and Vuex store modules making use of this client are generated in the `vue/src/store` directory. ## Client code generation diff --git a/docs/readme.md b/docs/readme.md index 53284bac9d..257147aea0 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -1,6 +1,6 @@ # Website -This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. +This website is built using [Docusaurus 2](https://docusaurus.io), a modern static website generator. ### Installation diff --git a/docs/versioned_docs/version-v0.25.2/clients/01-typescript.md b/docs/versioned_docs/version-v0.25.2/clients/01-typescript.md index 6b60708786..4dd8e148e3 100644 --- a/docs/versioned_docs/version-v0.25.2/clients/01-typescript.md +++ b/docs/versioned_docs/version-v0.25.2/clients/01-typescript.md @@ -37,8 +37,8 @@ To prevent regenerating the client, remove the `client:typescript` property from ## Setup -The best way to get started building with the TypeScript client is by using a [Vite](https://vitejs.dev/) boilerplate. Vite provides boilerplates for vanilla TS projects as well as react, vue, lit, svelte and preact frameworks. -You can find additional information at the [Vite Getting Started guide](https://vitejs.dev/guide/). +The best way to get started building with the TypeScript client is by using a [Vite](https://vitejs.dev) boilerplate. Vite provides boilerplates for vanilla TS projects as well as react, vue, lit, svelte and preact frameworks. +You can find additional information at the [Vite Getting Started guide](https://vitejs.dev/guide). You will also need to polyfill the client's dependencies. The following is an example of setting up a vanilla TS project with the necessary polyfills. diff --git a/docs/versioned_docs/version-v0.25.2/contributing/02-technical-setup.md b/docs/versioned_docs/version-v0.25.2/contributing/02-technical-setup.md index 9d1d9a8001..d295f14b76 100644 --- a/docs/versioned_docs/version-v0.25.2/contributing/02-technical-setup.md +++ b/docs/versioned_docs/version-v0.25.2/contributing/02-technical-setup.md @@ -7,7 +7,7 @@ To ensure you have a successful experience working with our Developer Tutorials ## Setting up Visual Studio Code -1. Install [Visual Studio Code](https://vscode-docs.readthedocs.io/en/latest/editor/setup/). +1. Install [Visual Studio Code](https://vscode-docs.readthedocs.io/en/latest/editor/setup). 1. Click **Extensions** in the sidebar. 1. Install this extension: - Go for VS Code The official Go extension for Visual Studio Code @@ -35,7 +35,7 @@ Master your terminal to be happy. ### iTerm2 terminal emulator -On macOS, install the [iTerm2](https://iterm2.com/) OSS terminal emulator as a replacement for the default Terminal app. Installing iTerm2 as a replacement for Terminal provides an updated version of the Bash shell that supports useful features like programmable completion. +On macOS, install the [iTerm2](https://iterm2.com) OSS terminal emulator as a replacement for the default Terminal app. Installing iTerm2 as a replacement for Terminal provides an updated version of the Bash shell that supports useful features like programmable completion. ### Using ZSH as your default shell diff --git a/docs/versioned_docs/version-v0.25.2/contributing/templates/02-tutorial-template.md b/docs/versioned_docs/version-v0.25.2/contributing/templates/02-tutorial-template.md index 9db57f9b38..111cead287 100644 --- a/docs/versioned_docs/version-v0.25.2/contributing/templates/02-tutorial-template.md +++ b/docs/versioned_docs/version-v0.25.2/contributing/templates/02-tutorial-template.md @@ -62,9 +62,9 @@ To complete this tutorial, you will need: diff --git a/docs/versioned_docs/version-v0.25.2/guide/04-nameservice/00-tutorial.md b/docs/versioned_docs/version-v0.25.2/guide/04-nameservice/00-tutorial.md index 526f8749ce..fb6f993bcb 100644 --- a/docs/versioned_docs/version-v0.25.2/guide/04-nameservice/00-tutorial.md +++ b/docs/versioned_docs/version-v0.25.2/guide/04-nameservice/00-tutorial.md @@ -26,9 +26,9 @@ This tutorial guides you through these steps to build a blockchain for a nameser ## Prerequisites -- A supported version of [Ignite CLI](https://docs.ignite.com/). To install Ignite CLI, see [Install Ignite CLI](../01-install.md). +- A supported version of [Ignite CLI](/). To install Ignite CLI, see [Install Ignite CLI](../01-install.md). * A text editor like [Visual Studio Code](https://code.visualstudio.com/download). -* A web browser like [Chrome](https://www.google.com/chrome/) or [Firefox](https://www.mozilla.org/en-US/firefox/new/). +* A web browser like [Chrome](https://www.google.com/chrome) or [Firefox](https://www.mozilla.org/en-US/firefox/new). - Familiarity with [Cosmos SDK modules](https://docs.cosmos.network/main/building-modules/intro.html) ## Nameservice App Goals @@ -41,8 +41,8 @@ First, see how these simple requirements translate to app design. A blockchain app is a [replicated deterministic state machine](https://en.wikipedia.org/wiki/State_machine_replication). As a blockchain app developer, you have to define the state machine with a starting state and messages that trigger state transitions. These software components make it all possible! -- [Ignite CLI](https://docs.ignite.com/) is built on top of Cosmos SDK and accelerates chain development by scaffolding everything you need. -- The [Cosmos SDK](https://github.com/cosmos/cosmos-sdk/) modular framework allows developers like you to create custom blockchains that can natively interact with other blockchains. +- [Ignite CLI](/) is built on top of Cosmos SDK and accelerates chain development by scaffolding everything you need. +- The [Cosmos SDK](https://github.com/cosmos/cosmos-sdk) modular framework allows developers like you to create custom blockchains that can natively interact with other blockchains. - [Tendermint](https://docs.tendermint.com/main/introduction/what-is-tendermint.html) software securely and consistently replicates an app on many machines. The Tendermint app-agnostic engine handles the networking and consensus layers of your blockchain. ## Cosmos SDK Modules diff --git a/docs/versioned_docs/version-v0.25.2/guide/04-nameservice/01-init.md b/docs/versioned_docs/version-v0.25.2/guide/04-nameservice/01-init.md index b03814ce7a..f44a918f8a 100644 --- a/docs/versioned_docs/version-v0.25.2/guide/04-nameservice/01-init.md +++ b/docs/versioned_docs/version-v0.25.2/guide/04-nameservice/01-init.md @@ -9,7 +9,7 @@ Scaffold a blockchain and create a `nameservice` module for the nameservice app. ## Create a Blockchain -Scaffold a new Cosmos SDK blockchain using the `ignite scaffold chain` command. The [ignite scaffold chain](https://docs.ignite.com/cli#ignite-scaffold-chain) command accepts one argument: the Go module path that is used for the project. +Scaffold a new Cosmos SDK blockchain using the `ignite scaffold chain` command. The [ignite scaffold chain](/cli#ignite-scaffold-chain) command accepts one argument: the Go module path that is used for the project. By default, a chain is scaffolded with a new empty Cosmos SDK module. You want to create the nameservice module without scaffolding a module, so use the `--no-module` flag: diff --git a/docs/versioned_docs/version-v0.25.2/guide/04-nameservice/02-messages.md b/docs/versioned_docs/version-v0.25.2/guide/04-nameservice/02-messages.md index b5b3616613..add5059651 100644 --- a/docs/versioned_docs/version-v0.25.2/guide/04-nameservice/02-messages.md +++ b/docs/versioned_docs/version-v0.25.2/guide/04-nameservice/02-messages.md @@ -70,7 +70,7 @@ Now, you are ready to implement these Cosmos SDK messages to achieve the desired Use the `ignite scaffold message` command to scaffold new messages for your module. -- The [`ignite scaffold message`](https://docs.ignite.com/#ignite-scaffold-message) command accepts the message name as the first argument and a list of fields for the message. +- The [`ignite scaffold message`](/cli#ignite-scaffold-message) command accepts the message name as the first argument and a list of fields for the message. - By default, a message is scaffolded in a module with a name that matches the name of the project, in this case `nameservice`. ### Add the MsgBuyName Message diff --git a/docs/versioned_docs/version-v0.25.2/guide/04-nameservice/03-types.md b/docs/versioned_docs/version-v0.25.2/guide/04-nameservice/03-types.md index be3c71c9c7..f76215e56f 100644 --- a/docs/versioned_docs/version-v0.25.2/guide/04-nameservice/03-types.md +++ b/docs/versioned_docs/version-v0.25.2/guide/04-nameservice/03-types.md @@ -11,7 +11,7 @@ Now that you've defined messages that trigger state transitions, it's time to im For the nameservice blockchain, define a `whois` type and the create and delete methods. -Because Ignite CLI does the heavy lifting for you, choose from several [ignite scaffold](https://docs.ignite.com/cli#ignite-scaffold) commands to create CRUD functionality code for data stored in different ways: +Because Ignite CLI does the heavy lifting for you, choose from several [ignite scaffold](/cli#ignite-scaffold) commands to create CRUD functionality code for data stored in different ways: - Array, a list-like data structure - Map (key-value pairs) diff --git a/docs/versioned_docs/version-v0.25.2/guide/06-loan.md b/docs/versioned_docs/version-v0.25.2/guide/06-loan.md index ff8c8d3068..1172deb67e 100644 --- a/docs/versioned_docs/version-v0.25.2/guide/06-loan.md +++ b/docs/versioned_docs/version-v0.25.2/guide/06-loan.md @@ -100,7 +100,7 @@ Use the `--dep` flag to specify that this module depends on and is going to inte ## Scaffold a list -Use the [scaffold list](https://docs.ignite.com/cli#ignite-scaffold-list) command to scaffold code necessary to store loans in an array-like data structure: +Use the [scaffold list](/cli#ignite-scaffold-list) command to scaffold code necessary to store loans in an array-like data structure: ```bash ignite scaffold list loan amount fee collateral deadline state borrower lender --no-message diff --git a/docs/versioned_docs/version-v0.25.2/index.md b/docs/versioned_docs/version-v0.25.2/index.md index df2c7853b0..7fbbd2cb6b 100644 --- a/docs/versioned_docs/version-v0.25.2/index.md +++ b/docs/versioned_docs/version-v0.25.2/index.md @@ -39,7 +39,7 @@ Many projects already showcase the Tendermint BFT consensus engine and the Cosmo ## Projects building with Ignite CLI * [Sifchain: omni-chain solution for DEXs](https://github.com/Sifchain/sifnode) -* [Kyve](https://www.kyve.network/) +* [Kyve](https://www.kyve.network) * [crypto.org chain](https://github.com/crypto-org-chain/chain-main) ([initialized with Ignite CLI](https://github.com/crypto-org-chain/chain-main/commit/37b2ecb49a9aae7c581270a4f2dbecfcd8e8a6e9)) * [Cronos](https://github.com/crypto-org-chain/cronos) * [Plugchain](https://github.com/oracleNetworkProtocol/plugchain) diff --git a/docs/versioned_docs/version-v0.25.2/kb/00-kb.md b/docs/versioned_docs/version-v0.25.2/kb/00-kb.md index 2950174eeb..a411d8e2d3 100644 --- a/docs/versioned_docs/version-v0.25.2/kb/00-kb.md +++ b/docs/versioned_docs/version-v0.25.2/kb/00-kb.md @@ -7,4 +7,4 @@ slug: /kb Knowledge base articles cover different aspects of Ignite CLI. This online library includes reference content on supported types, protocol buffer files, chain simulation as well as an overview of scaffolding a chain all the way to starting an IBC relayer. -If you're new to Ignite CLI or want to go through a series of tutorials, visit the [Developer Tutorials](https://docs.ignite.com/guide). +If you're new to Ignite CLI or want to go through a series of tutorials, visit the [Developer Tutorials](/guide). diff --git a/docs/versioned_docs/version-v0.25.2/kb/07-frontend.md b/docs/versioned_docs/version-v0.25.2/kb/07-frontend.md index cdc5a6921d..81eaa15870 100644 --- a/docs/versioned_docs/version-v0.25.2/kb/07-frontend.md +++ b/docs/versioned_docs/version-v0.25.2/kb/07-frontend.md @@ -23,7 +23,7 @@ client: path: "vue/src/store" ``` -A TS client is generated in the `ts-client` directory (see: [TypeScript client information](https://docs.ignite.com/clients/typescript)) and Vuex store modules making use of this client are generated in the `vue/src/store` directory. +A TS client is generated in the `ts-client` directory (see: [TypeScript client information](/clients/typescript)) and Vuex store modules making use of this client are generated in the `vue/src/store` directory. ## Client code regeneration diff --git a/ignite/cmd/cmd.go b/ignite/cmd/cmd.go index fa3345a763..3dfe95b2b8 100644 --- a/ignite/cmd/cmd.go +++ b/ignite/cmd/cmd.go @@ -265,7 +265,7 @@ func checkNewVersion(ctx context.Context) { fmt.Printf(`路 路 馃浉 Ignite CLI %s is available! 路 -路 To upgrade your Ignite CLI version, see the upgrade doc: https://docs.ignite.com/guide/install.html#upgrading-your-ignite-cli-installation +路 To upgrade your Ignite CLI version, see the upgrade doc: https://docs.ignite.com/guide/install#upgrading-your-ignite-cli-installation 路 路路 diff --git a/readme.md b/readme.md index 2e879fdb94..61a3ec8c65 100644 --- a/readme.md +++ b/readme.md @@ -10,8 +10,8 @@ Ignite CLI generates boilerplate code for you, so you can focus on writing busin ## Quick start Open Ignite CLI [in your web browser](https://gitpod.io/#https://github.com/ignite/cli/tree/master) (or -open [nightly version](https://gitpod.io/#https://github.com/ignite/cli/)), -or [install the latest release](https://docs.ignite.com/guide/install.html). +open [nightly version](https://gitpod.io/#https://github.com/ignite/cli)), +or [install the latest release](https://docs.ignite.com/guide/install). To create and start a blockchain: @@ -29,7 +29,7 @@ To learn how to use Ignite CLI, check out the [Ignite CLI docs](https://docs.ign build blockchain apps with Ignite CLI, see the [Ignite CLI Developer Tutorials](https://docs.ignite.com/guide). To install Ignite CLI locally on GNU, Linux, or macOS, -see [Install Ignite CLI](https://docs.ignite.com/guide/install.html). +see [Install Ignite CLI](https://docs.ignite.com/guide/install). To learn more about building a JavaScript frontend for your Cosmos SDK blockchain, see [ignite/web](https://github.com/ignite/web). @@ -41,7 +41,7 @@ repo is exclusively for bug reports and feature requests. ## Cosmos SDK compatibility -Blockchains created with Ignite CLI use the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk/) framework. To ensure the +Blockchains created with Ignite CLI use the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk) framework. To ensure the best possible experience, use the version of Ignite CLI that corresponds to the version of Cosmos SDK that your blockchain is built with. Unless noted otherwise, a row refers to a minor version and all associated patch versions. @@ -59,7 +59,7 @@ blockchain is built with. Unless noted otherwise, a row refers to a minor versio | v0.17 | v0.42 | Same with Cosmos SDK | | To upgrade your blockchain to the newer version of Cosmos SDK, see -the [Migration guide](https://docs.ignite.com/migration/). +the [Migration guide](https://docs.ignite.com/migration/v0.18). ## Plugin system @@ -76,10 +76,10 @@ plugins: // the directory must contain go code under a main package. // For repositories you can specify a suffix @branch or @tag to target a // specific git reference. -- path: github.com/org/repo/my-plugin - // Additional parameters can be passed to the plugin - with: - key: value + - path: github.com/org/repo/my-plugin + // Additional parameters can be passed to the plugin + with: + key: value ``` Once declared, the next time the ignite binary will be executed under this @@ -111,7 +111,7 @@ instance: ```yaml plugins: -- path: /home/user/src/bar + - path: /home/user/src/bar ``` Then run `ignite`, the plugin will compile and should be listed among the @@ -126,7 +126,7 @@ We welcome contributions from everyone. The `develop` branch contains the develo create a branch from `develop` and create a pull request, or maintain your own fork and submit a cross-repository pull request. -Our [Ignite CLI bounty program](docs/bounty/index.md) provides incentives for your participation and pays rewards. Track +Our [Ignite CLI bounty program](https://docs.ignite.com/bounty) provides incentives for your participation and pays rewards. Track new, in-progress, and completed bounties on the [Bounty board](https://github.com/ignite/cli/projects/5) in GitHub. **Important** Before you start implementing a new Ignite CLI feature, the first step is to create an issue on GitHub @@ -142,8 +142,8 @@ Stay in touch. * [ignite.com website](https://ignite.com) * [@ignite\_dev on Twitter](https://twitter.com/ignite_dev) -* [ignite.com/blog](https://ignite.com/blog/) +* [ignite.com/blog](https://ignite.com/blog) * [Ignite Discord](https://discord.com/invite/ignite) -* [Ignite YouTube](https://www.youtube.com/ignitehq) -* [Ignite docs](https://docs.ignite.com/) +* [Ignite YouTube](https://www.youtube.com/@ignitehq) +* [Ignite docs](https://docs.ignite.com) * [Ignite jobs](https://ignite.com/careers)