diff --git a/docs/docs.go b/docs/docs.go index 3094352c72..6a548c13a4 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -2,7 +2,7 @@ package docs import "embed" -// Docs are Ignite CLI docs. +// Docs are IGNITE® CLI docs. // //go:embed docs var Docs embed.FS diff --git a/docs/docs/01-welcome/01-index.md b/docs/docs/01-welcome/01-index.md index 4a547d5f1e..17b3eb26d5 100644 --- a/docs/docs/01-welcome/01-index.md +++ b/docs/docs/01-welcome/01-index.md @@ -4,24 +4,24 @@ slug: /welcome import ProjectsTable from '@site/src/components/ProjectsTable'; -# Introduction to Ignite CLI: Your Gateway to Blockchain Innovation +# Introduction to IGNITE® CLI: Your Gateway to Blockchain Innovation -[Ignite CLI](https://github.com/ignite/cli) is a powerful tool that simplifies the journey of building, testing, and launching diverse blockchain applications. Developed on top of the [Cosmos SDK](https://docs.cosmos.network), the leading framework for blockchain technology, Ignite CLI is pivotal in streamlining the development process. It enables developers to focus on the unique aspects of their projects, from DeFi and NFTs to supply chain solutions and smart contracts. -Beyond these, Ignite has been instrumental in a wide array of blockchain applications, ranging from VPNs and gaming platforms to blogs, oracle systems, and innovative consensus mechanisms. This demonstrates its versatility in supporting a broad spectrum of blockchain-based solutions. +[IGNITE® CLI](https://github.com/ignite/cli) is a powerful tool that simplifies the journey of building, testing, and launching diverse blockchain applications. Developed on top of the [Cosmos SDK](https://docs.cosmos.network), the leading framework for blockchain technology, IGNITE® CLI is pivotal in streamlining the development process. It enables developers to focus on the unique aspects of their projects, from DeFi and NFTs to supply chain solutions and smart contracts. +Beyond these, IGNITE® has been instrumental in a wide array of blockchain applications, ranging from VPNs and gaming platforms to blogs, oracle systems, and innovative consensus mechanisms. This demonstrates its versatility in supporting a broad spectrum of blockchain-based solutions. -## Key Features of Ignite CLI +## Key Features of IGNITE® CLI -- **Simplified Blockchain Development:** Ignite CLI, leveraging Cosmos SDK, makes building sovereign application-specific blockchains intuitive and efficient. +- **Simplified Blockchain Development:** IGNITE® CLI, leveraging Cosmos SDK, makes building sovereign application-specific blockchains intuitive and efficient. - **Comprehensive Scaffolding:** Easily scaffold modules, messages, CRUD operations, IBC packets, and more, expediting the development of complex functionalities. - **Development with Live Reloading:** Start and test your blockchain node with real-time updates, enhancing your development workflow. - **Frontend Flexibility:** Utilize pre-built templates for Vue.js, React, Typescript or Go, catering to diverse frontend development needs. - **Inter-Blockchain Communication (IBC):** Seamlessly connect and interact with other blockchains using an integrated IBC relayer, a key feature of the Cosmos SDK. - **CometBFT Integration:** Built with the CometBFT consensus engine (formerly Tendermint), ensuring robust consensus mechanisms in your blockchain solutions. -- **Cross-Domain Applications:** Ignite is perfectly suited for developing a diverse array of use cases across various sectors. These include DeFi, NFTs, supply chain management, smart contracts (both EVM and WASM), and decentralized exchanges (DEXes). +- **Cross-Domain Applications:** IGNITE® is perfectly suited for developing a diverse array of use cases across various sectors. These include DeFi, NFTs, supply chain management, smart contracts (both EVM and WASM), and decentralized exchanges (DEXes). ## Embracing the Cosmos Ecosystem -Ignite CLI is your entry point into the vibrant Cosmos ecosystem, a hub of innovation where you can explore a range of applications, from wallets and explorers to smart contracts and DEXes, all powered by CometBFT and the Cosmos SDK. +IGNITE® CLI is your entry point into the vibrant Cosmos ecosystem, a hub of innovation where you can explore a range of applications, from wallets and explorers to smart contracts and DEXes, all powered by CometBFT and the Cosmos SDK. This ecosystem is home to over [$100 billion worth of blockchain projects](https://cosmos.network/ecosystem/tokens/), showcasing the scalability and versatility of the technologies at play. ## Projects using Tendermint and Cosmos SDK @@ -30,7 +30,7 @@ Many projects already showcase the Tendermint BFT consensus engine and the Cosmo the [Cosmos ecosystem](https://cosmos.network/ecosystem/apps) to discover a wide variety of apps, blockchains, wallets, and explorers that are built in the Cosmos ecosystem. -## Projects building with Ignite CLI +## Projects building with IGNITE® CLI --` -Finally, the Ignite CLI-generated AppendPost function returns the ID of the new +Finally, the IGNITE® CLI-generated AppendPost function returns the ID of the new appended post. You can return this value to the source chain through acknowledgment. @@ -506,7 +506,7 @@ ignite app install -g github.com/ignite/apps/hermes ``` If you previously used the relayer, follow these steps to remove exiting relayer -and Ignite CLI configurations: +and IGNITE® CLI configurations: - Stop your blockchains and delete previous configuration files: @@ -664,6 +664,6 @@ Here's what you accomplished in this tutorial: - Built two Hello blockchain apps as IBC modules - Modified the generated code to add CRUD action logic -- Configured and used the Ignite CLI relayer to connect two blockchains with +- Configured and used the IGNITE® CLI relayer to connect two blockchains with each other - Transferred IBC packets from one blockchain to another diff --git a/docs/docs/02-guide/05-debug.md b/docs/docs/02-guide/05-debug.md index 6822463741..50eae06b83 100644 --- a/docs/docs/02-guide/05-debug.md +++ b/docs/docs/02-guide/05-debug.md @@ -4,7 +4,7 @@ description: Debugging your Cosmos SDK blockchain # Debugging a chain -Ignite chain debug command can help you find issues during development. It uses +IGNITE® chain debug command can help you find issues during development. It uses [Delve](https://github.com/go-delve/delve) debugger which enables you to interact with your blockchain app by controlling the execution of the process, evaluating variables, and providing information of thread / goroutine state, CPU @@ -138,7 +138,7 @@ Connect to Server" and enter the debug host address and then the port number. ## Example: Debugging a Blockchain App -In this short example we will be using Ignite CLI to create a new blockchain and +In this short example we will be using IGNITE® CLI to create a new blockchain and a query to be able to trigger a debugging breakpoint when the query is called. Create a new blockchain: diff --git a/docs/docs/02-guide/06-docker.md b/docs/docs/02-guide/06-docker.md index f1c27d3fa6..bbe6ee426d 100644 --- a/docs/docs/02-guide/06-docker.md +++ b/docs/docs/02-guide/06-docker.md @@ -1,18 +1,18 @@ --- -description: Run Ignite CLI using a Docker container. +description: Run IGNITE® CLI using a Docker container. --- # Running inside a Docker container -You can run Ignite CLI inside a Docker container without installing the Ignite +You can run IGNITE® CLI inside a Docker container without installing the IGNITE® CLI binary directly on your machine. -Running Ignite CLI in Docker can be useful for various reasons; isolating your -test environment, running Ignite CLI on an unsupported operating system, or -experimenting with a different version of Ignite CLI without installing it. +Running IGNITE® CLI in Docker can be useful for various reasons; isolating your +test environment, running IGNITE® CLI on an unsupported operating system, or +experimenting with a different version of IGNITE® CLI without installing it. Docker containers are like virtual machines because they provide an isolated -environment to programs that runs inside them. In this case, you can run Ignite +environment to programs that runs inside them. In this case, you can run IGNITE® CLI in an isolated environment. Experimentation and file system impact is limited to the Docker instance. The @@ -23,9 +23,9 @@ host machine is not impacted by changes to the container. Docker must be installed. See [Get Started with Docker](https://www.docker.com/get-started). -## Ignite CLI Commands in Docker +## IGNITE® CLI Commands in Docker -After you scaffold and start a chain in your Docker container, all Ignite CLI +After you scaffold and start a chain in your Docker container, all IGNITE® CLI commands are available. Just type the commands after `docker run -ti ignite/cli`. For example: @@ -39,7 +39,7 @@ docker run -ti ignitehq/cli chain serve When Docker is installed, you can build a blockchain with a single command. -Ignite CLI, and the chains you serve with Ignite CLI, persist some files. When +IGNITE® CLI, and the chains you serve with IGNITE® CLI, persist some files. When using the CLI binary directly, those files are located in `$HOME/.ignite` and `$HOME/.cache`, but in the context of Docker it's better to use a directory different from `$HOME`, so we use `$HOME/sdh`. This folder should be created @@ -61,7 +61,7 @@ Be patient, this command takes a minute or two to run because it does everything for you: - Creates a container that runs from the `ignitehq/cli:0.25.2` image. -- Executes the Ignite CLI binary inside the image. +- Executes the IGNITE® CLI binary inside the image. - `-v $HOME/sdh:/home/tendermint` maps the `$HOME/sdh` directory in your local computer (the host machine) to the home directory `/home/tendermint` inside the container. @@ -108,13 +108,13 @@ This command does the following: ## Versioning -You can specify which version of Ignite CLI to install and run in your Docker +You can specify which version of IGNITE® CLI to install and run in your Docker container. ### Latest version - By default, `ignite/cli` resolves to `ignite/cli:latest`. -- The `latest` image tag is always the latest stable [Ignite CLI +- The `latest` image tag is always the latest stable [IGNITE® CLI release](https://github.com/ignite/cli/releases). For example, if latest release is @@ -123,7 +123,7 @@ points to the `0.25.2` tag. ### Specific version -You can specify to use a specific version of Ignite CLI. All available tags are +You can specify to use a specific version of IGNITE® CLI. All available tags are in the [ignite/cli image](https://hub.docker.com/r/ignitehq/cli/tags?page=1&ordering=last_updated) on Docker Hub. diff --git a/docs/docs/02-guide/07-simapp.md b/docs/docs/02-guide/07-simapp.md index bb3486e7e0..a67b9a96cb 100644 --- a/docs/docs/02-guide/07-simapp.md +++ b/docs/docs/02-guide/07-simapp.md @@ -5,7 +5,7 @@ description: Test different scenarios for your chain. # Chain simulation -The Ignite CLI chain simulator can help you to run your chain based in +The IGNITE® CLI chain simulator can help you to run your chain based in randomized inputs for you can make fuzz testing and also benchmark test for your chain, simulating the messages, blocks, and accounts. You can scaffold a template to perform simulation testing in each module along with a boilerplate @@ -13,7 +13,7 @@ simulation methods for each scaffolded message. ## Module simulation -Every new module that is scaffolded with Ignite CLI implements the Cosmos SDK +Every new module that is scaffolded with IGNITE® CLI implements the Cosmos SDK [Module Simulation](https://docs.cosmos.network/main/building-modules/simulator). diff --git a/docs/docs/02-guide/08-state.md b/docs/docs/02-guide/08-state.md index a4a7925f3f..1acaaeeb0a 100644 --- a/docs/docs/02-guide/08-state.md +++ b/docs/docs/02-guide/08-state.md @@ -9,7 +9,7 @@ In blockchain applications, state refers to the current data stored on the block ## Collections Package -Ignite scaffolds using the [`collections`](http://pkg.go.dev/cosmossdk.io/collections) package for module code. This package provides a type-safe and efficient way to set and query values from the module store. +IGNITE® scaffolds using the [`collections`](http://pkg.go.dev/cosmossdk.io/collections) package for module code. This package provides a type-safe and efficient way to set and query values from the module store. ### Key Features of Collections @@ -20,7 +20,7 @@ Ignite scaffolds using the [`collections`](http://pkg.go.dev/cosmossdk.io/collec ## Understand keeper field -Ignite creates all the necessary boilerplate for collections in the `x//keeper/keeper.go` file. The `Keeper` struct contains fields for each collection you define in your module. Each field is an instance of a collection type, such as `collections.Map`, `collections.Item`, or `collections.List`. +IGNITE® creates all the necessary boilerplate for collections in the `x//keeper/keeper.go` file. The `Keeper` struct contains fields for each collection you define in your module. Each field is an instance of a collection type, such as `collections.Map`, `collections.Item`, or `collections.List`. ```go type Keeper struct { @@ -227,4 +227,4 @@ if err != nil { The `collections` package provides a powerful and type-safe way to manage state in Cosmos SDK modules. By understanding how to use collections effectively, you can build robust and efficient blockchain applications that handle state transitions reliably. -When developing with Ignite CLI, you are already taking advantage of collections which significantly simplify the state management code and reduce the potential for errors. +When developing with IGNITE® CLI, you are already taking advantage of collections which significantly simplify the state management code and reduce the potential for errors. diff --git a/docs/docs/03-CLI-Commands/01-cli-commands.md b/docs/docs/03-CLI-Commands/01-cli-commands.md index 6e30eb1733..072a0d735b 100644 --- a/docs/docs/03-CLI-Commands/01-cli-commands.md +++ b/docs/docs/03-CLI-Commands/01-cli-commands.md @@ -1,18 +1,18 @@ --- -description: Ignite CLI docs. +description: IGNITE® CLI docs. --- # CLI commands -Documentation for Ignite CLI. +Documentation for IGNITE® CLI. ## ignite -Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain +IGNITE® CLI offers everything you need to scaffold, test, build, and launch your blockchain **Synopsis** -Ignite CLI is a tool for creating sovereign blockchains built with Cosmos SDK, the world's -most popular modular blockchain framework. Ignite CLI offers everything you need to scaffold, +IGNITE® CLI is a tool for creating sovereign blockchains built with Cosmos SDK, the world's +most popular modular blockchain framework. IGNITE® CLI offers everything you need to scaffold, test, build, and launch your blockchain. To get started, create a blockchain: @@ -22,7 +22,7 @@ $ ignite scaffold chain example Announcements: ⋆ A new release has appeared! v29.8.0 has just been released :) -⋆ Satisfied with Ignite? Or totally fed-up with it? Tell us: https://bit.ly/3WZS2uS +⋆ Satisfied with IGNITE®? Or totally fed-up with it? Tell us: https://bit.ly/3WZS2uS **Options** @@ -33,12 +33,12 @@ Announcements: **SEE ALSO** -* [ignite account](#ignite-account) - Create, delete, and show Ignite accounts -* [ignite app](#ignite-app) - Create and manage Ignite Apps -* [ignite appregistry](#ignite-appregistry) - Browse the Ignite App Registry App +* [ignite account](#ignite-account) - Create, delete, and show IGNITE® accounts +* [ignite app](#ignite-app) - Create and manage IGNITE® Apps +* [ignite appregistry](#ignite-appregistry) - Browse the IGNITE® App Registry App * [ignite chain](#ignite-chain) - Build, init and start a blockchain node * [ignite completion](#ignite-completion) - Generates shell completion script. -* [ignite docs](#ignite-docs) - Show Ignite CLI docs +* [ignite docs](#ignite-docs) - Show IGNITE® CLI docs * [ignite generate](#ignite-generate) - Generate clients, API docs from source code * [ignite relayer](#ignite-relayer) - Connect blockchains with an IBC relayer * [ignite scaffold](#ignite-scaffold) - Create a new blockchain, module, message, query, and more @@ -48,15 +48,15 @@ Announcements: ## ignite account -Create, delete, and show Ignite accounts +Create, delete, and show IGNITE® accounts **Synopsis** -Commands for managing Ignite accounts. An Ignite account is a private/public -keypair stored in a keyring. Currently Ignite accounts are used when interacting -with Ignite Apps (namely ignite relayer, ignite network and ignite connect). +Commands for managing IGNITE® accounts. An IGNITE® account is a private/public +keypair stored in a keyring. Currently IGNITE® accounts are used when interacting +with IGNITE® Apps (namely ignite relayer, ignite network and ignite connect). -Note: Ignite account commands are not for managing your chain's keys and accounts. Use +Note: IGNITE® account commands are not for managing your chain's keys and accounts. Use you chain's binary to manage accounts from "config.yml". For example, if your blockchain is called "mychain", use "mychaind keys" to manage keys for the chain. @@ -72,7 +72,7 @@ chain. **SEE ALSO** -* [ignite](#ignite) - Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain +* [ignite](#ignite) - IGNITE® CLI offers everything you need to scaffold, test, build, and launch your blockchain * [ignite account create](#ignite-account-create) - Create a new account * [ignite account delete](#ignite-account-delete) - Delete an account by name * [ignite account export](#ignite-account-export) - Export an account as a private key @@ -105,7 +105,7 @@ ignite account create [name] [flags] **SEE ALSO** -* [ignite account](#ignite-account) - Create, delete, and show Ignite accounts +* [ignite account](#ignite-account) - Create, delete, and show IGNITE® accounts ## ignite account delete @@ -131,7 +131,7 @@ ignite account delete [name] [flags] **SEE ALSO** -* [ignite account](#ignite-account) - Create, delete, and show Ignite accounts +* [ignite account](#ignite-account) - Create, delete, and show IGNITE® accounts ## ignite account export @@ -160,7 +160,7 @@ ignite account export [name] [flags] **SEE ALSO** -* [ignite account](#ignite-account) - Create, delete, and show Ignite accounts +* [ignite account](#ignite-account) - Create, delete, and show IGNITE® accounts ## ignite account import @@ -190,7 +190,7 @@ ignite account import [name] [flags] **SEE ALSO** -* [ignite account](#ignite-account) - Create, delete, and show Ignite accounts +* [ignite account](#ignite-account) - Create, delete, and show IGNITE® accounts ## ignite account list @@ -217,7 +217,7 @@ ignite account list [flags] **SEE ALSO** -* [ignite account](#ignite-account) - Create, delete, and show Ignite accounts +* [ignite account](#ignite-account) - Create, delete, and show IGNITE® accounts ## ignite account show @@ -244,12 +244,12 @@ ignite account show [name] [flags] **SEE ALSO** -* [ignite account](#ignite-account) - Create, delete, and show Ignite accounts +* [ignite account](#ignite-account) - Create, delete, and show IGNITE® accounts ## ignite app -Create and manage Ignite Apps +Create and manage IGNITE® Apps **Options** @@ -259,11 +259,11 @@ Create and manage Ignite Apps **SEE ALSO** -* [ignite](#ignite) - Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain +* [ignite](#ignite) - IGNITE® CLI offers everything you need to scaffold, test, build, and launch your blockchain * [ignite app describe](#ignite-app-describe) - Print information about installed apps * [ignite app install](#ignite-app-install) - Install app * [ignite app list](#ignite-app-list) - List installed apps -* [ignite app scaffold](#ignite-app-scaffold) - Scaffold a new Ignite App +* [ignite app scaffold](#ignite-app-scaffold) - Scaffold a new IGNITE® App * [ignite app uninstall](#ignite-app-uninstall) - Uninstall app * [ignite app update](#ignite-app-update) - Update app @@ -274,7 +274,7 @@ Print information about installed apps **Synopsis** -Print information about an installed Ignite App commands and hooks. +Print information about an installed IGNITE® App commands and hooks. ``` ignite app describe [path] [flags] @@ -294,7 +294,7 @@ ignite app describe github.com/org/my-app/ **SEE ALSO** -* [ignite app](#ignite-app) - Create and manage Ignite Apps +* [ignite app](#ignite-app) - Create and manage IGNITE® Apps ## ignite app install @@ -303,7 +303,7 @@ Install app **Synopsis** -Installs an Ignite App. +Installs an IGNITE® App. Respects key value pairs declared after the app path to be added to the generated configuration definition. @@ -326,7 +326,7 @@ ignite app install github.com/org/my-app/ foo=bar baz=qux **SEE ALSO** -* [ignite app](#ignite-app) - Create and manage Ignite Apps +* [ignite app](#ignite-app) - Create and manage IGNITE® Apps ## ignite app list @@ -335,7 +335,7 @@ List installed apps **Synopsis** -Prints status and information of all installed Ignite Apps. +Prints status and information of all installed IGNITE® Apps. ``` ignite app list [flags] @@ -349,16 +349,16 @@ ignite app list [flags] **SEE ALSO** -* [ignite app](#ignite-app) - Create and manage Ignite Apps +* [ignite app](#ignite-app) - Create and manage IGNITE® Apps ## ignite app scaffold -Scaffold a new Ignite App +Scaffold a new IGNITE® App **Synopsis** -Scaffolds a new Ignite App in the current directory. +Scaffolds a new IGNITE® App in the current directory. A git repository will be created with the given module name, unless the current directory is already a git repository. @@ -380,7 +380,7 @@ ignite app scaffold github.com/org/my-app/ **SEE ALSO** -* [ignite app](#ignite-app) - Create and manage Ignite Apps +* [ignite app](#ignite-app) - Create and manage IGNITE® Apps ## ignite app uninstall @@ -389,7 +389,7 @@ Uninstall app **Synopsis** -Uninstalls an Ignite App specified by path. +Uninstalls an IGNITE® App specified by path. ``` ignite app uninstall [path] [flags] @@ -410,7 +410,7 @@ ignite app uninstall github.com/org/my-app/ **SEE ALSO** -* [ignite app](#ignite-app) - Create and manage Ignite Apps +* [ignite app](#ignite-app) - Create and manage IGNITE® Apps ## ignite app update @@ -419,7 +419,7 @@ Update app **Synopsis** -Updates an Ignite App specified by path. +Updates an IGNITE® App specified by path. If no path is specified all declared apps are updated. @@ -441,12 +441,12 @@ ignite app update github.com/org/my-app/ **SEE ALSO** -* [ignite app](#ignite-app) - Create and manage Ignite Apps +* [ignite app](#ignite-app) - Create and manage IGNITE® Apps ## ignite appregistry -Browse the Ignite App Registry App +Browse the IGNITE® App Registry App ``` ignite appregistry [flags] @@ -460,7 +460,7 @@ ignite appregistry [flags] **SEE ALSO** -* [ignite](#ignite) - Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain +* [ignite](#ignite) - IGNITE® CLI offers everything you need to scaffold, test, build, and launch your blockchain ## ignite chain @@ -473,7 +473,7 @@ Commands in this namespace let you to build, initialize, and start your blockchain node locally for development purposes. To run these commands you should be inside the project's directory so that -Ignite can find the source code. To ensure that you are, run "ls", you should +IGNITE® can find the source code. To ensure that you are, run "ls", you should see the following files in the output: "go.mod", "x", "proto", "app", etc. By default the "build" command will identify the "main" package of the project, @@ -521,14 +521,14 @@ chain. **Options** ``` - -c, --config string path to Ignite config file (default: ./config.yml) + -c, --config string path to IGNITE® config file (default: ./config.yml) -h, --help help for chain -y, --yes answers interactive yes/no questions with yes ``` **SEE ALSO** -* [ignite](#ignite) - Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain +* [ignite](#ignite) - IGNITE® CLI offers everything you need to scaffold, test, build, and launch your blockchain * [ignite chain build](#ignite-chain-build) - Build a node binary * [ignite chain debug](#ignite-chain-debug) - Launch a debugger for a blockchain app * [ignite chain faucet](#ignite-chain-faucet) - Send coins to an account @@ -553,24 +553,24 @@ You can customize the output directory for the binary using a flag: ignite chain build --output dist -To compile the binary Ignite first compiles protocol buffer (proto) files into +To compile the binary IGNITE® first compiles protocol buffer (proto) files into Go source code. Proto files contain required type and services definitions. If you're using another program to compile proto files, you can use a flag to tell -Ignite to skip the proto compilation step: +IGNITE® to skip the proto compilation step: ignite chain build --skip-proto -Afterwards, Ignite install dependencies specified in the go.mod file. By default -Ignite doesn't check that dependencies of the main module stored in the module +Afterwards, IGNITE® install dependencies specified in the go.mod file. By default +IGNITE® doesn't check that dependencies of the main module stored in the module cache have not been modified since they were downloaded. To enforce dependency checking (essentially, running "go mod verify") use a flag: ignite chain build --check-dependencies -Next, Ignite identifies the "main" package of the project. By default the "main" +Next, IGNITE® identifies the "main" package of the project. By default the "main" package is located in "cmd/{app}d" directory, where "{app}" is the name of the scaffolded project and "d" stands for daemon. If your project contains more -than one "main" package, specify the path to the one that Ignite should compile +than one "main" package, specify the path to the one that IGNITE® should compile in config.yml: build: @@ -622,7 +622,7 @@ ignite chain build [flags] **Options inherited from parent commands** ``` - -c, --config string path to Ignite config file (default: ./config.yml) + -c, --config string path to IGNITE® config file (default: ./config.yml) -y, --yes answers interactive yes/no questions with yes ``` @@ -639,7 +639,7 @@ Launch a debugger for a blockchain app The debug command starts a debug server and launches a debugger. -Ignite uses the Delve debugger by default. Delve enables you to interact with +IGNITE® uses the Delve debugger by default. Delve enables you to interact with your program by controlling the execution of the process, evaluating variables, and providing information of thread / goroutine state, CPU register state and more. @@ -676,7 +676,7 @@ ignite chain debug [flags] **Options inherited from parent commands** ``` - -c, --config string path to Ignite config file (default: ./config.yml) + -c, --config string path to IGNITE® config file (default: ./config.yml) -y, --yes answers interactive yes/no questions with yes ``` @@ -705,7 +705,7 @@ ignite chain faucet [address] [coin<,...>] [flags] **Options inherited from parent commands** ``` - -c, --config string path to Ignite config file (default: ./config.yml) + -c, --config string path to IGNITE® config file (default: ./config.yml) -y, --yes answers interactive yes/no questions with yes ``` @@ -757,7 +757,7 @@ default the gas price is set to 0 to allow "free" transactions), sets the block time to 5s, and changes the output format to JSON. To see what kind of values this configuration accepts see the generated TOML files in the data directory. -As part of the initialization process Ignite creates on-chain accounts with +As part of the initialization process IGNITE® creates on-chain accounts with token balances. By default, config.yml has two accounts in the top-level "accounts" property. You can add more accounts and change their token balances. Refer to config.yml guide to see which values you can set. @@ -807,7 +807,7 @@ ignite chain init [flags] **Options inherited from parent commands** ``` - -c, --config string path to Ignite config file (default: ./config.yml) + -c, --config string path to IGNITE® config file (default: ./config.yml) -y, --yes answers interactive yes/no questions with yes ``` @@ -837,7 +837,7 @@ ignite chain lint [flags] **Options inherited from parent commands** ``` - -c, --config string path to Ignite config file (default: ./config.yml) + -c, --config string path to IGNITE® config file (default: ./config.yml) -y, --yes answers interactive yes/no questions with yes ``` @@ -863,7 +863,7 @@ The modules command allows you to manage modules in the codebase. **Options inherited from parent commands** ``` - -c, --config string path to Ignite config file (default: ./config.yml) + -c, --config string path to IGNITE® config file (default: ./config.yml) -y, --yes answers interactive yes/no questions with yes ``` @@ -894,7 +894,7 @@ ignite chain modules list [flags] **Options inherited from parent commands** ``` - -c, --config string path to Ignite config file (default: ./config.yml) + -c, --config string path to IGNITE® config file (default: ./config.yml) -y, --yes answers interactive yes/no questions with yes ``` @@ -914,24 +914,24 @@ uses that binary to initialize the blockchain's data directory for one validator (like "ignite chain init"), and starts the node locally for development purposes with automatic code reloading. -Automatic code reloading means Ignite starts watching the project directory. -Whenever a file change is detected, Ignite automatically rebuilds, reinitializes +Automatic code reloading means IGNITE® starts watching the project directory. +Whenever a file change is detected, IGNITE® automatically rebuilds, reinitializes and restarts the node. -Whenever possible Ignite will try to keep the current state of the chain by +Whenever possible IGNITE® will try to keep the current state of the chain by exporting and importing the genesis file. -To force Ignite to start from a clean slate even if a genesis file exists, use +To force IGNITE® to start from a clean slate even if a genesis file exists, use the following flag: ignite chain serve --reset-once -To force Ignite to reset the state every time the source code is modified, use +To force IGNITE® to reset the state every time the source code is modified, use the following flag: ignite chain serve --force-reset -With Ignite it's possible to start more than one blockchain from the same source +With IGNITE® it's possible to start more than one blockchain from the same source code using different config files. This is handy if you're building inter-blockchain functionality and, for example, want to try sending packets from one blockchain to another. To start a node using a specific config file: @@ -969,7 +969,7 @@ ignite chain serve [flags] **Options inherited from parent commands** ``` - -c, --config string path to Ignite config file (default: ./config.yml) + -c, --config string path to IGNITE® config file (default: ./config.yml) -y, --yes answers interactive yes/no questions with yes ``` @@ -1012,7 +1012,7 @@ ignite chain simulate [flags] **Options inherited from parent commands** ``` - -c, --config string path to Ignite config file (default: ./config.yml) + -c, --config string path to IGNITE® config file (default: ./config.yml) -y, --yes answers interactive yes/no questions with yes ``` @@ -1037,12 +1037,12 @@ ignite completion [bash|zsh|fish|powershell] [flags] **SEE ALSO** -* [ignite](#ignite) - Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain +* [ignite](#ignite) - IGNITE® CLI offers everything you need to scaffold, test, build, and launch your blockchain ## ignite docs -Show Ignite CLI docs +Show IGNITE® CLI docs ``` ignite docs [flags] @@ -1056,7 +1056,7 @@ ignite docs [flags] **SEE ALSO** -* [ignite](#ignite) - Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain +* [ignite](#ignite) - IGNITE® CLI offers everything you need to scaffold, test, build, and launch your blockchain ## ignite generate @@ -1086,7 +1086,7 @@ meant to be edited by hand. **SEE ALSO** -* [ignite](#ignite) - Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain +* [ignite](#ignite) - IGNITE® CLI offers everything you need to scaffold, test, build, and launch your blockchain * [ignite generate composables](#ignite-generate-composables) - TypeScript frontend client and Vue 3 composables * [ignite generate openapi](#ignite-generate-openapi) - OpenAPI spec for your chain * [ignite generate proto-go](#ignite-generate-proto-go) - Compile protocol buffer files to Go source code required by Cosmos SDK @@ -1250,7 +1250,7 @@ ignite relayer [flags] **SEE ALSO** -* [ignite](#ignite) - Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain +* [ignite](#ignite) - IGNITE® CLI offers everything you need to scaffold, test, build, and launch your blockchain ## ignite scaffold @@ -1266,7 +1266,7 @@ For details on each scaffolding target (chain, module, message, etc.) run the corresponding command with a "--help" flag, for example, "ignite scaffold chain --help". -The Ignite team strongly recommends committing the code to a version control +The IGNITE® team strongly recommends committing the code to a version control system before running scaffolding commands. This will make it easier to see the changes to the source code as well as undo the command if you've decided to roll back the changes. @@ -1323,7 +1323,7 @@ with an "--ibc" flag. Note that the default module is not IBC-enabled. **SEE ALSO** -* [ignite](#ignite) - Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain +* [ignite](#ignite) - IGNITE® CLI offers everything you need to scaffold, test, build, and launch your blockchain * [ignite scaffold chain](#ignite-scaffold-chain) - New Cosmos SDK blockchain * [ignite scaffold chain-registry](#ignite-scaffold-chain-registry) - Configs for the chain registry * [ignite scaffold configs](#ignite-scaffold-configs) - Configs for a custom Cosmos SDK module @@ -1367,7 +1367,7 @@ To use a different path use the "--path" flag. Most of the logic of your blockchain is written in custom modules. Each module effectively encapsulates an independent piece of functionality. Following the Cosmos SDK convention, custom modules are stored inside the "x/" directory. By -default, Ignite creates a module with a name that matches the name of the +default, IGNITE® creates a module with a name that matches the name of the project. To create a blockchain without a default module use the "--no-module" flag. Additional modules can be added after a project is created with "ignite scaffold module" command. @@ -1379,7 +1379,7 @@ use a custom address prefix use the "--address-prefix" flag. For example: ignite scaffold chain foo --address-prefix bar -By default when compiling a blockchain's source code Ignite creates a cache to +By default when compiling a blockchain's source code IGNITE® creates a cache to speed up the build process. To clear the cache when building a blockchain use the "--clear-cache" flag. It is very unlikely you will ever need to use this flag. @@ -1560,13 +1560,13 @@ For detailed type information use ignite scaffold type --help "Index" indicates whether the type can be used as an index in "ignite scaffold map". -Ignite also supports custom types: +IGNITE® also supports custom types: ignite scaffold list product-details name desc ignite scaffold list product price:coin details:ProductDetails In the example above the "ProductDetails" type was defined first, and then used -as a custom type for the "details" field. Ignite doesn't support arrays of +as a custom type for the "details" field. IGNITE® doesn't support arrays of custom types yet. Your chain will accept custom types in JSON-notation: @@ -1714,7 +1714,7 @@ accounts. The send message has three fields: from address (sender), to address the token amount will be deducted from the sender's account and added to the recipient's account. -Ignite's message scaffolding lets you create new types of messages and add them +IGNITE®'s message scaffolding lets you create new types of messages and add them to your chain. For example: ignite scaffold message add-pool amount:coins denom active:bool --module dex @@ -1728,10 +1728,10 @@ For detailed type information use ignite scaffold type --help By default, the message is defined as a proto message in the "proto/{app}/{module}/tx.proto" and registered in the "Msg" service. A CLI command to create and broadcast a transaction with MsgAddPool is created in the module's -"cli" package. Additionally, Ignite scaffolds a message constructor and the code +"cli" package. Additionally, IGNITE® scaffolds a message constructor and the code to satisfy the sdk.Msg interface and register the message in the module. -Most importantly in the "keeper" package Ignite scaffolds an "AddPool" function. +Most importantly in the "keeper" package IGNITE® scaffolds an "AddPool" function. Inside this function, you can implement message handling logic. When successfully processed a message can return data. Use the —response flag to @@ -2178,7 +2178,7 @@ Comprehensive toolset for managing and simulating blockchain test networks. It a **SEE ALSO** -* [ignite](#ignite) - Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain +* [ignite](#ignite) - IGNITE® CLI offers everything you need to scaffold, test, build, and launch your blockchain * [ignite testnet in-place](#ignite-testnet-in-place) - Create and start a testnet from current local net state * [ignite testnet multi-node](#ignite-testnet-multi-node) - Initialize and provide multi-node on/off functionality * [ignite testnet simulate](#ignite-testnet-simulate) - Run simulation testing for the blockchain @@ -2320,7 +2320,7 @@ ignite version [flags] **SEE ALSO** -* [ignite](#ignite) - Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain +* [ignite](#ignite) - IGNITE® CLI offers everything you need to scaffold, test, build, and launch your blockchain # Scaffold Type diff --git a/docs/docs/04-clients/01-go-client.md b/docs/docs/04-clients/01-go-client.md index 2a2ecdf98f..abbbc46e60 100644 --- a/docs/docs/04-clients/01-go-client.md +++ b/docs/docs/04-clients/01-go-client.md @@ -6,7 +6,7 @@ title: Go client # A client in the Go programming language In this tutorial, we will show you how to create a standalone Go program that -serves as a client for a blockchain. We will use the Ignite CLI to set up a +serves as a client for a blockchain. We will use the IGNITE® CLI to set up a standard blockchain. To communicate with the blockchain, we will utilize the `cosmosclient` package, which provides an easy-to-use interface for interacting with the blockchain. You will learn how to use the `cosmosclient` package to @@ -16,7 +16,7 @@ Go and the `cosmosclient` package. ## Create a blockchain -To create a blockchain using the Ignite CLI, use the following command: +To create a blockchain using the IGNITE® CLI, use the following command: ``` ignite scaffold chain blog diff --git a/docs/docs/04-clients/02-typescript.md b/docs/docs/04-clients/02-typescript.md index 525cd6b764..c5cfeffb11 100644 --- a/docs/docs/04-clients/02-typescript.md +++ b/docs/docs/04-clients/02-typescript.md @@ -4,7 +4,7 @@ description: Information about the generated TypeScript client code. # TypeScript library -Ignite offers powerful functionality for generating client-side code for your +IGNITE® offers powerful functionality for generating client-side code for your blockchain. Think of this as a one-click client SDK generation tailored specifically for your blockchain. @@ -37,7 +37,7 @@ ignite generate ts-client --clear-cache :::tip In order to not rely on the remote `buf.build` service, you can install the -`protoc-gen-ts_proto` binary locally and Ignite will use it instead of the remote plugin. +`protoc-gen-ts_proto` binary locally and IGNITE® will use it instead of the remote plugin. ```sh npm install -g ts-proto @@ -201,7 +201,7 @@ const tx_result = await client.CosmosBankV1Beta1.tx.sendMsgSend({ ## Broadcasting a transaction with a custom message If your chain already has custom messages defined, you can use those. If not, -we'll be using Ignite's scaffolded code as an example. Create a post with CRUD +we'll be using IGNITE®'s scaffolded code as an example. Create a post with CRUD messages: ``` diff --git a/docs/docs/04-clients/03-vue.md b/docs/docs/04-clients/03-vue.md index 66f8d8fd9f..edb483ca84 100644 --- a/docs/docs/04-clients/03-vue.md +++ b/docs/docs/04-clients/03-vue.md @@ -2,17 +2,17 @@ :::warning The Vue frontend is being reworked and is not yet stable. -In the meantime, refer to the [Ignite CCA App](https://ignite.com/marketplace/cca). +In the meantime, refer to the [IGNITE® CCA App](https://ignite.com/marketplace/cca). ::: -Welcome to this tutorial on using Ignite to develop a web application for your -blockchain with Vue 3. Ignite is a tool that simplifies the process of building +Welcome to this tutorial on using IGNITE® to develop a web application for your +blockchain with Vue 3. IGNITE® is a tool that simplifies the process of building a blockchain application by providing a set of templates and generators that can be used to get up and running quickly. -One of the features of Ignite is its support for [Vue 3](https://vuejs.org/), a +One of the features of IGNITE® is its support for [Vue 3](https://vuejs.org/), a popular JavaScript framework for building user interfaces. In this tutorial, you -will learn how to use Ignite to create a new blockchain and scaffold a Vue +will learn how to use IGNITE® to create a new blockchain and scaffold a Vue frontend template. This will give you a basic foundation for your web application and make it easier to get started building out the rest of your application. @@ -91,7 +91,7 @@ accounts: Replace the `struggle since...` mnemonic with the one you saved in the previous step. -Adding an account with a mnemonic to the config file will tell Ignite CLI to add +Adding an account with a mnemonic to the config file will tell IGNITE® CLI to add the account to the blockchain when you start it. This is useful for development purposes, but you should not do this in production. @@ -143,7 +143,7 @@ properly interact with a Cosmos chain. The address prefix is used to identify the chain that the app is connected to, and must match the prefix used by the chain. -By default, Ignite creates a chain with the `cosmos` prefix. If you have +By default, IGNITE® creates a chain with the `cosmos` prefix. If you have created your chain with `ignite scaffold chain ... --address-prefix foo` or manually changed the prefix in the source code of the chain, you need to set the prefix in the Vue app. diff --git a/docs/docs/05-contributing/01-docs.md b/docs/docs/05-contributing/01-docs.md index de8ff3e12a..108c520018 100644 --- a/docs/docs/05-contributing/01-docs.md +++ b/docs/docs/05-contributing/01-docs.md @@ -11,7 +11,7 @@ and documentation. ## Using this repo -Review existing [Ignite CLI issues](https://github.com/ignite/cli/issues) to see +Review existing [IGNITE® CLI issues](https://github.com/ignite/cli/issues) to see if your question has already been asked and answered. - To provide feedback, file an issue and provide generous details to help us @@ -68,7 +68,7 @@ Other useful resources: Technical content includes knowledge base articles and interactive tutorials. -- The Ignite CLI Developer Tutorials content is in the `docs/guide` folder. +- The IGNITE® CLI Developer Tutorials content is in the `docs/guide` folder. - The Knowledge Base content is in the `docs/kb` folder. - Upgrade information is in the `docs/migration` folder. @@ -84,11 +84,11 @@ repos. ## Who works on the tutorials? -The Ignite product team developers are focused on building Ignite CLI and -improving the developer experience. The Ignite Ecosystem Development team owns +The IGNITE® product team developers are focused on building IGNITE® CLI and +improving the developer experience. The IGNITE® Ecosystem Development team owns the technical content and tutorials and manages developer onboarding. -Meet the [people behind Ignite CLI and our +Meet the [people behind IGNITE® CLI and our contributors](https://github.com/ignite/cli/graphs/contributors). ## Viewing docs builds diff --git a/docs/docs/05-contributing/_category_.json b/docs/docs/05-contributing/_category_.json index e88b1ff8fe..481a2d665e 100644 --- a/docs/docs/05-contributing/_category_.json +++ b/docs/docs/05-contributing/_category_.json @@ -1,4 +1,4 @@ { - "label": "Contribute to Ignite", + "label": "Contribute to IGNITE®", "link": null } \ No newline at end of file diff --git a/docs/docs/06-migration/readme.md b/docs/docs/06-migration/readme.md index 5666cf7cc8..d1e74a0940 100644 --- a/docs/docs/06-migration/readme.md +++ b/docs/docs/06-migration/readme.md @@ -4,20 +4,20 @@ sidebar_position: 0 # Migration Guides -Welcome to the section on upgrading to a newer version of Ignite CLI! If you're +Welcome to the section on upgrading to a newer version of IGNITE® CLI! If you're looking to update to the latest version, you'll want to start by checking the documentation to see if there are any special considerations or instructions you need to follow. -If there is no documentation for the latest version of Ignite CLI, it's +If there is no documentation for the latest version of IGNITE® CLI, it's generally safe to assume that there were no breaking changes, and you can proceed with using the latest version with your project. ## Create your own Migration Guide -The `gen-mig-diffs` tool helps developers manage and visualize code changes across multiple major versions of Ignite. With each major upgrade, the codebase might undergo significant changes, making it challenging for developers to track these differences after several updates. The `gen-mig-diffs` tool simplifies this process by scaffolding blockchains with both the old and new versions and displaying the differences. +The `gen-mig-diffs` tool helps developers manage and visualize code changes across multiple major versions of IGNITE®. With each major upgrade, the codebase might undergo significant changes, making it challenging for developers to track these differences after several updates. The `gen-mig-diffs` tool simplifies this process by scaffolding blockchains with both the old and new versions and displaying the differences. -It is located in the [Ignite CLI GitHub repository](https://github.com/ignite/cli/tree/main/ignite/internal/tools/gen-mig-diffs) +It is located in the [IGNITE® CLI GitHub repository](https://github.com/ignite/cli/tree/main/ignite/internal/tools/gen-mig-diffs) directory and has been made into a standalone project. To set up this tool in your development environment: @@ -26,11 +26,11 @@ To set up this tool in your development environment: gen-mig-diffs [flags] ``` -This tool generates migration diff files for each of Ignite's scaffold commands. It compares two specified versions of Ignite and provides a clear, organized view of the changes. +This tool generates migration diff files for each of IGNITE®'s scaffold commands. It compares two specified versions of IGNITE® and provides a clear, organized view of the changes. ## How to Get Started -1. Clone the Ignite CLI repository: +1. Clone the IGNITE® CLI repository: ```shell git clone https://github.com/ignite/cli.git --depth=1 && \ @@ -62,13 +62,13 @@ Usage: gen-mig-diffs [flags] Flags: - -f, --from string Version of Ignite or path to Ignite source code to generate the diff from + -f, --from string Version of IGNITE® or path to IGNITE® source code to generate the diff from -h, --help help for gen-mig-diffs -o, --output string Output directory to save the migration document (default "docs/docs/06-migration") - --repo-output string Output path to clone the Ignite repository - -s, --repo-source string Path to Ignite source code repository. Set the source automatically set the cleanup to false - --repo-url string Git URL for the Ignite repository (default "https://github.com/ignite/cli.git") + --repo-output string Output path to clone the IGNITE® repository + -s, --repo-source string Path to IGNITE® source code repository. Set the source automatically set the cleanup to false + --repo-url string Git URL for the IGNITE® repository (default "https://github.com/ignite/cli.git") --scaffold-cache string Path to cache directory - --scaffold-output string Output path to clone the Ignite repository - -t, --to string Version of Ignite or path to Ignite source code to generate the diff to + --scaffold-output string Output path to clone the IGNITE® repository + -t, --to string Version of IGNITE® or path to IGNITE® source code to generate the diff to ``` diff --git a/docs/docs/06-migration/v0.18.md b/docs/docs/06-migration/v0.18.md index d7ce7ef20e..729cfaee30 100644 --- a/docs/docs/06-migration/v0.18.md +++ b/docs/docs/06-migration/v0.18.md @@ -1,15 +1,15 @@ --- sidebar_position: 999 title: v0.18.0 -description: For chains that were scaffolded with Ignite CLI versions lower than v0.18, changes are required to use Ignite CLI v0.18. +description: For chains that were scaffolded with IGNITE® CLI versions lower than v0.18, changes are required to use IGNITE® CLI v0.18. --- -# Upgrading a Blockchain to use Ignite CLI v0.18 +# Upgrading a Blockchain to use IGNITE® CLI v0.18 -Ignite CLI v0.18 comes with Cosmos SDK v0.44. This version of Cosmos SDK introduced changes that are not compatible with -chains that were scaffolded with Ignite CLI versions lower than v0.18. +IGNITE® CLI v0.18 comes with Cosmos SDK v0.44. This version of Cosmos SDK introduced changes that are not compatible with +chains that were scaffolded with IGNITE® CLI versions lower than v0.18. -**Important:** After upgrading from Ignite CLI v0.17.3 to Ignite CLI v0.18, you must update the default blockchain +**Important:** After upgrading from IGNITE® CLI v0.17.3 to IGNITE® CLI v0.18, you must update the default blockchain template to use blockchains that were scaffolded with earlier versions. These instructions are written for a blockchain that was scaffolded with the following command: diff --git a/docs/docs/06-migration/v0.19.2.md b/docs/docs/06-migration/v0.19.2.md index 0ee04f20d3..fee9a0d2a1 100644 --- a/docs/docs/06-migration/v0.19.2.md +++ b/docs/docs/06-migration/v0.19.2.md @@ -1,17 +1,17 @@ --- sidebar_position: 998 title: v0.19.2 -description: For chains that were scaffolded with Ignite CLI versions lower than v0.19.2, changes are required to use Ignite CLI v0.19.2. +description: For chains that were scaffolded with IGNITE® CLI versions lower than v0.19.2, changes are required to use IGNITE® CLI v0.19.2. --- -# Upgrading a blockchain to use Ignite CLI v0.19.2 +# Upgrading a blockchain to use IGNITE® CLI v0.19.2 -Ignite CLI v0.19.2 comes with IBC v2.0.2. +IGNITE® CLI v0.19.2 comes with IBC v2.0.2. -With Ignite CLI v0.19.2, the contents of the deprecated Ignite CLI Modules `tendermint/spm` repo are moved to the -official Ignite CLI repo which introduces breaking changes. +With IGNITE® CLI v0.19.2, the contents of the deprecated IGNITE® CLI Modules `tendermint/spm` repo are moved to the +official IGNITE® CLI repo which introduces breaking changes. -To migrate your chain that was scaffolded with Ignite CLI versions lower than v0.19.2: +To migrate your chain that was scaffolded with IGNITE® CLI versions lower than v0.19.2: 1. IBC upgrade: Use the [IBC migration documents](https://github.com/cosmos/ibc-go/blob/v6.2.0/docs/migrations/v1-to-v2.md) diff --git a/docs/docs/06-migration/v0.20.0.md b/docs/docs/06-migration/v0.20.0.md index df23fa9bf8..8303168bfc 100644 --- a/docs/docs/06-migration/v0.20.0.md +++ b/docs/docs/06-migration/v0.20.0.md @@ -1,10 +1,10 @@ --- sidebar_position: 997 title: v0.20.0 -description: For chains that were scaffolded with Ignite CLI versions lower than v0.20.0, changes are required to use Ignite CLI v0.20.0. +description: For chains that were scaffolded with IGNITE® CLI versions lower than v0.20.0, changes are required to use IGNITE® CLI v0.20.0. --- -# Upgrading a blockchain to use Ignite CLI v0.20.2 +# Upgrading a blockchain to use IGNITE® CLI v0.20.2 1. Upgrade your Cosmos SDK version to [v0.45.3](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.45.3). diff --git a/docs/docs/06-migration/v0.22.0.md b/docs/docs/06-migration/v0.22.0.md index 54ea27ebde..4cb032fff3 100644 --- a/docs/docs/06-migration/v0.22.0.md +++ b/docs/docs/06-migration/v0.22.0.md @@ -1,15 +1,15 @@ --- sidebar_position: 996 title: v0.22.0 -description: For chains that were scaffolded with Ignite CLI versions lower than v0.22.0, changes are required to use Ignite CLI v0.22.0. +description: For chains that were scaffolded with IGNITE® CLI versions lower than v0.22.0, changes are required to use IGNITE® CLI v0.22.0. --- -# Upgrading a blockchain to use Ignite CLI v0.22.0 +# Upgrading a blockchain to use IGNITE® CLI v0.22.0 -Ignite CLI v0.22.2 changed the GitHub username from "ignite-hq" to "ignite", which means the imports must be fixed to +IGNITE® CLI v0.22.2 changed the GitHub username from "ignite-hq" to "ignite", which means the imports must be fixed to reflect this change. -1. In your `go.mod` file find the require line for Ignite CLI that starts with `github.com/ignite-hq/cli` and is +1. In your `go.mod` file find the require line for IGNITE® CLI that starts with `github.com/ignite-hq/cli` and is followed by a version. It looks something like `github.com/ignite-hq/cli v0.22.0`, and replace it by `github.com/ignite/cli v0.22.2`. diff --git a/docs/docs/06-migration/v0.24.0.md b/docs/docs/06-migration/v0.24.0.md index e927bd2ce3..2fd5fbbeca 100644 --- a/docs/docs/06-migration/v0.24.0.md +++ b/docs/docs/06-migration/v0.24.0.md @@ -1,7 +1,7 @@ --- sidebar_position: 995 title: v0.24.0 -description: For chains that were scaffolded with Ignite CLI versions lower than v0.24, changes are required to use Ignite CLI v0.24.0. +description: For chains that were scaffolded with IGNITE® CLI versions lower than v0.24, changes are required to use IGNITE® CLI v0.24.0. --- ## Cosmos SDK v0.46 upgrade notes diff --git a/docs/docs/06-migration/v0.25.0.md b/docs/docs/06-migration/v0.25.0.md index 35db7963f2..47356b7e45 100644 --- a/docs/docs/06-migration/v0.25.0.md +++ b/docs/docs/06-migration/v0.25.0.md @@ -1,7 +1,7 @@ --- sidebar_position: 994 title: v0.25.0 -description: For chains that were scaffolded with Ignite CLI versions lower than v0.25.0. changes are required to use Ignite CLI v0.25.0. +description: For chains that were scaffolded with IGNITE® CLI versions lower than v0.25.0. changes are required to use IGNITE® CLI v0.25.0. --- ## Protobuf directory migration diff --git a/docs/docs/06-migration/v0.25.1.md b/docs/docs/06-migration/v0.25.1.md index 42fe7f783c..caa96e5312 100644 --- a/docs/docs/06-migration/v0.25.1.md +++ b/docs/docs/06-migration/v0.25.1.md @@ -1,7 +1,7 @@ --- sidebar_position: 993 title: v0.25.1 -description: For chains that were scaffolded with Ignite CLI versions lower than v0.25.1. changes are required to use Ignite CLI v0.25.1. +description: For chains that were scaffolded with IGNITE® CLI versions lower than v0.25.1. changes are required to use IGNITE® CLI v0.25.1. --- ## Drabonberry fix diff --git a/docs/docs/06-migration/v0.26.0.md b/docs/docs/06-migration/v0.26.0.md index de3576dbe8..21efcce367 100644 --- a/docs/docs/06-migration/v0.26.0.md +++ b/docs/docs/06-migration/v0.26.0.md @@ -1,28 +1,28 @@ --- sidebar_position: 992 title: v0.26.0 -description: For chains that were scaffolded with Ignite CLI versions lower than v0.26.0. changes are required to use Ignite CLI v0.26.0. +description: For chains that were scaffolded with IGNITE® CLI versions lower than v0.26.0. changes are required to use IGNITE® CLI v0.26.0. --- -Ignite CLI `v0.26.0` is fully compatible with chains that are compatible with `v0.25.1`. Please follow the existing +IGNITE® CLI `v0.26.0` is fully compatible with chains that are compatible with `v0.25.1`. Please follow the existing migration guides if your chain is not upgraded to `v0.25.1` support. ## Go Version -Chains that are newly scaffolded with Ignite CLI `v0.26.0` now require `go 1.19` in their `go.mod` files. It is -recommended that chains scaffolded with an older version of Ignite CLI also bump their required `go` version and update +Chains that are newly scaffolded with IGNITE® CLI `v0.26.0` now require `go 1.19` in their `go.mod` files. It is +recommended that chains scaffolded with an older version of IGNITE® CLI also bump their required `go` version and update their tooling to the latest version. ## ibc-go v6 -Chains that are newly scaffolded with Ignite CLI `v0.26.0` now use `ibc-go/v6` for ibc functionality. It is not +Chains that are newly scaffolded with IGNITE® CLI `v0.26.0` now use `ibc-go/v6` for ibc functionality. It is not necessary, but recommended to upgrade to the newest version of `ibc-go`. Most migrations can be done by following the `ibc-go` [migration guide](https://github.com/cosmos/ibc-go/blob/v6.2.0/docs/migrations/v5-to-v6.md), but there are some -specific changes that will need to be followed for Ignite scaffolded chains. +specific changes that will need to be followed for IGNITE® scaffolded chains. ### Removing `cosmosibckeeper` -Ignite CLI `v0.26.0` has deprecated [pkg/cosmosibckeeper](https://github.com/ignite/cli/tree/v0.26.0/ignite/pkg/cosmosibckeeper). +IGNITE® CLI `v0.26.0` has deprecated [pkg/cosmosibckeeper](https://github.com/ignite/cli/tree/v0.26.0/ignite/pkg/cosmosibckeeper). This package contained interfaces for ibc-related keepers. Newly scaffolded chains now include the interface files in their `./x/{moduleName}/types` directory in a new `expected_ibc_keeper.go` file. To migrate, create the following file for each module: diff --git a/docs/docs/06-migration/v0.27.1.md b/docs/docs/06-migration/v0.27.1.md index b14c0b0313..88d0e336f0 100644 --- a/docs/docs/06-migration/v0.27.1.md +++ b/docs/docs/06-migration/v0.27.1.md @@ -1,7 +1,7 @@ --- sidebar_position: 991 title: v0.27.1 -description: For chains that were scaffolded with Ignite CLI versions lower than v0.27.0. changes are required to use Ignite CLI v0.27.1. +description: For chains that were scaffolded with IGNITE® CLI versions lower than v0.27.0. changes are required to use IGNITE® CLI v0.27.1. --- ## Cosmos SDK v0.47.3 upgrade notes @@ -63,7 +63,7 @@ You might need to replace the following imports: ### App changes -Applications scaffolded with older version of Ignite CLI would require the following changes +Applications scaffolded with older version of IGNITE® CLI would require the following changes to some of the app files: ```text title="app/app.go" @@ -1034,10 +1034,10 @@ RunE: func(cmd *cobra.Command, args []string) (err error) { ## ibc-go v7 -Chains that are newly scaffolded with Ignite CLI `v0.27.1` now use `ibc-go/v7` for IBC functionality. It is +Chains that are newly scaffolded with IGNITE® CLI `v0.27.1` now use `ibc-go/v7` for IBC functionality. It is required to upgrade to the newest version of `ibc-go`. -Applications scaffolded with older version of Ignite CLI require the following changes to the app file: +Applications scaffolded with older version of IGNITE® CLI require the following changes to the app file: ```text title="app/app.go" import ( diff --git a/docs/docs/06-migration/v28.0.0.md b/docs/docs/06-migration/v28.0.0.md index 7ece1836f6..75bff3b6cb 100644 --- a/docs/docs/06-migration/v28.0.0.md +++ b/docs/docs/06-migration/v28.0.0.md @@ -1,12 +1,12 @@ --- sidebar_position: 990 title: v28.0.0 -description: For chains that were scaffolded with Ignite CLI versions lower than v28.0.0 changes are required to use Ignite CLI v28.0.0 +description: For chains that were scaffolded with IGNITE® CLI versions lower than v28.0.0 changes are required to use IGNITE® CLI v28.0.0 --- -## **Upgrade to v28.0.0 - New Versioning Scheme in Ignite** +## **Upgrade to v28.0.0 - New Versioning Scheme in IGNITE®** -With the latest update, Ignite has transitioned its versioning format from a leading-zero release system to a full number release system. This change marks a significant shift in how we communicate updates and stability in our software. Where the previous version was denoted as v0.27.0, it will now be upgraded to v28.0.0. +With the latest update, IGNITE® has transitioned its versioning format from a leading-zero release system to a full number release system. This change marks a significant shift in how we communicate updates and stability in our software. Where the previous version was denoted as v0.27.0, it will now be upgraded to v28.0.0. This new versioning approach enhances our version control by clearly indicating major, minor, and patch releases. From now on first number indicates a major release with breaking API changes, second number indicates minor release that might include new features while the last number is typically focused on bug fixes and minor improvements. @@ -14,7 +14,7 @@ From now on first number indicates a major release with breaking API changes, se ## **Plugins are now called Apps. Upgrade Configuration Files** -Ignite `v28.0.0` changes the plugin system which is now called Ignite Apps. This version includes changes +IGNITE® `v28.0.0` changes the plugin system which is now called IGNITE® Apps. This version includes changes to the CLI command names and the plugin configuration file. The plugins configuration file is now called `igniteapps.yml` and "plugins" are now called "apps". @@ -24,22 +24,22 @@ The plugins configuration home directory is now `$HOME/.ignite/apps` instead `$H Updates can be automatically applied by running `ignite doctor` in your blockchain application directory. Running the command outside your blockchain application directory will only update the global plugins. -## **Ignite and Cosmos SDK Upgrade Guide: From Ignite v0.27.0 to v28.0.0 and Cosmos SDK v0.47 to v0.50** +## **IGNITE® and Cosmos SDK Upgrade Guide: From IGNITE® v0.27.0 to v28.0.0 and Cosmos SDK v0.47 to v0.50** ### **Introduction** -This guide provides a step-by-step process for developers to upgrade their applications from Ignite version 0.27.0 to 28.0.0, along with an upgrade in the Cosmos SDK from version 0.47 to v0.50. It covers essential changes, new features, and adjustments required for a smooth transition. +This guide provides a step-by-step process for developers to upgrade their applications from IGNITE® version 0.27.0 to 28.0.0, along with an upgrade in the Cosmos SDK from version 0.47 to v0.50. It covers essential changes, new features, and adjustments required for a smooth transition. ### **Prerequisites** - Backup your current project. -- Ensure you have Ignite v0.27.0 and Cosmos SDK v0.47 installed. +- Ensure you have IGNITE® v0.27.0 and Cosmos SDK v0.47 installed. - Basic familiarity with command line operations and the existing project structure. -### **Step 1: Update Ignite CLI to Version 28.0.0** +### **Step 1: Update IGNITE® CLI to Version 28.0.0** - **Command**: Run **`curl https://get.ignite.com/cli@v28.0.0 | bash`** in your terminal. -- **Note**: This command updates the Ignite CLI to the latest version. Ensure you have the necessary permissions to execute it. +- **Note**: This command updates the IGNITE® CLI to the latest version. Ensure you have the necessary permissions to execute it. ### **Step 2: Update Scaffold Chain Command** @@ -49,8 +49,8 @@ This guide provides a step-by-step process for developers to upgrade their appli ### **Step 3: Docker Version Upgrades** -- **Action**: Upgrade the Ignite version for the Docker container to match the CLI version. -- **Note**: Ensure Docker compatibility with the new Ignite CLI version. +- **Action**: Upgrade the IGNITE® version for the Docker container to match the CLI version. +- **Note**: Ensure Docker compatibility with the new IGNITE® CLI version. ### **Step 4: Change in Module Path** @@ -105,14 +105,14 @@ This guide provides a step-by-step process for developers to upgrade their appli ### **Troubleshooting Common Issues** -- **Dependency Conflicts**: Ensure compatibility of all dependencies with Ignite v28.0.0 and Cosmos SDK v0.50. +- **Dependency Conflicts**: Ensure compatibility of all dependencies with IGNITE® v28.0.0 and Cosmos SDK v0.50. - **Docker Image Compatibility**: Align Docker image versions with the CLI for seamless operations. - **Frontend Scaffolding**: For older projects, ensure correct scaffolding as per the new commands. - **AutoCLI Integration**: Address discrepancies due to the new AutoCLI integration path. ### **Additional Resources** -- [Ignite Documentation](https://docs.ignite.com/) +- [IGNITE® Documentation](https://docs.ignite.com/) - [Cosmos SDK Release Notes](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.50.1) ### **Feedback** @@ -121,4 +121,4 @@ We value your feedback on this guide. Please share your experiences and suggesti ### **Updates Log** -- **[01/15/24]**: Guide created for Ignite v28.0.0 and Cosmos SDK v0.50.1 \ No newline at end of file +- **[01/15/24]**: Guide created for IGNITE® v28.0.0 and Cosmos SDK v0.50.1 \ No newline at end of file diff --git a/docs/docs/06-migration/v29.0.0.md b/docs/docs/06-migration/v29.0.0.md index 94fbd7e192..d4758520a6 100644 --- a/docs/docs/06-migration/v29.0.0.md +++ b/docs/docs/06-migration/v29.0.0.md @@ -1,7 +1,7 @@ --- sidebar_position: 989 title: v29.0.0 -description: For chains that were scaffolded with Ignite CLI versions lower than v29.0.0 changes are required to use Ignite CLI v29.0.0 +description: For chains that were scaffolded with IGNITE® CLI versions lower than v29.0.0 changes are required to use IGNITE® CLI v29.0.0 --- ## Upgrade to v29.0.0 @@ -13,7 +13,7 @@ In v29.0.0, the Cosmos SDK version has been upgraded to 0.53.0 and IBC to v10. Please see the [Changelog](https://github.com/ignite/cli/commit/1b7f19f08d0fa91e3ae71b4b37b8bb4171a9e320#diff-b027e7b11ff55b21dd50b32abcbdd35d95be87a889f0f6562417fbf0995d402a) for more details. :::tip -If you wish to keep using a chain scaffolded with Ignite v28, simply run the doctor command: +If you wish to keep using a chain scaffolded with IGNITE® v28, simply run the doctor command: ```bash ignite doctor @@ -75,7 +75,7 @@ Then run the command `gen-mig-diffs --output temp/migration --from v28 --to v29` -Now, test if your blockchain runs using Ignite v29: +Now, test if your blockchain runs using IGNITE® v29: Update the dependencies with: @@ -83,7 +83,7 @@ Update the dependencies with: go mod tidy ``` -Then run the Ignite doctor to update configuration files. +Then run the IGNITE® doctor to update configuration files. ```bash ignite doctor diff --git a/docs/docs/08-configuration/01-config.md b/docs/docs/08-configuration/01-config.md index 47c5833c4c..c94f4577f5 100644 --- a/docs/docs/08-configuration/01-config.md +++ b/docs/docs/08-configuration/01-config.md @@ -6,7 +6,7 @@ title: Configuration File Documentation # Configuration File Reference -After scaffolding a blockchain with Ignite CLI, you will find a configuration file at the root of your newly created directory. +After scaffolding a blockchain with IGNITE® CLI, you will find a configuration file at the root of your newly created directory. The `config.yml` file generated in your blockchain folder uses key-value pairs to describe the development environment for your blockchain. @@ -39,7 +39,7 @@ data directory. You may need to customize specific parameters in the genesis file, such as `chain_id`, token balances, module parameters, or custom state. -To override genesis values with Ignite CLI, persistently set overrides in the `genesis`property of your `config.yml`. +To override genesis values with IGNITE® CLI, persistently set overrides in the `genesis`property of your `config.yml`. Any YAML structure under `genesis` will be merged into the generated `genesis.json` during initialization. Eg: Changing `chain_id` and `staking` parameters @@ -69,7 +69,7 @@ For more complex setups, you can use the `include` field in `config.yml` to spli ## Validation -Ignite uses the `validation` field to determine the kind of validation +IGNITE® uses the `validation` field to determine the kind of validation of your blockchain. There are currently two supported kinds of validation: - `sovereign` which is the standard kind of validation where your blockchain @@ -83,7 +83,7 @@ While the `sovereign` chain is the default validation when you run the `ignite s chain`, to scaffold a consumer chain, you have to run `ignite scaffold chain --consumer`. -This field is, at this time of writing, only used by Ignite at the genesis +This field is, at this time of writing, only used by IGNITE® at the genesis generation step, because the genesis of a sovereign chain and a consumer chain are different. @@ -99,8 +99,8 @@ accounts: coins: [ '10000token', '100000000stake' ] ``` -Ignite uses information from `accounts` when initializing the chain with `ignite -chain init` and `ignite chain start`. In the example above Ignite will add two +IGNITE® uses information from `accounts` when initializing the chain with `ignite +chain init` and `ignite chain start`. In the example above IGNITE® will add two accounts to the `genesis.json` file of the chain. `name` is a local name of a key pair associated with an account. Once the chain @@ -115,7 +115,7 @@ When initialized with the config file above, a chain will only have two accounts at genesis (Alice and Bob) and two native tokens (with denominations `token` and `stake`). -By default, every time a chain is re-initialized, Ignite will create a new key +By default, every time a chain is re-initialized, IGNITE® will create a new key pair for each account. So even though the account name can remain the same (`bob`), every chain reinitialize it will have a different mnemonic and address. @@ -126,7 +126,7 @@ pair will not be generated, because it's impossible to derive a key from an address. An account with a given address will be added to the genesis file (with an associated token balance), but because there is no key pair, you will not be able to broadcast transactions from that address. This is useful when you have -generated a key pair outside of Ignite (for example, using your chain's CLI or +generated a key pair outside of IGNITE® (for example, using your chain's CLI or in an extension wallet) and want to have a token balance associated with the address of this key pair. @@ -151,7 +151,7 @@ accounts: You cannot have both `address` and `mnemonic` defined for a single account. Some accounts are used as validator accounts (see `validators` section). -Validator accounts cannot have an `address` field, because Ignite needs to be +Validator accounts cannot have an `address` field, because IGNITE® needs to be able to derive a private key (either from a random mnemonic or from a specific one provided in the `mnemonic` field). Validator accounts should have enough tokens of the staking denomination for self-delegation. @@ -189,11 +189,11 @@ should not be lower than `1000000` nor higher than the account's balance in the `account` list. Validators store their node configuration files in the data directory. By -default, Ignite uses the name of the project as the name of the data directory, +default, IGNITE® uses the name of the project as the name of the data directory, for example, `$HOME/.example/`. To use a different path for the data directory you can customize the `home` property. -Configuration in the data directory is reset frequently by Ignite. To persist +Configuration in the data directory is reset frequently by IGNITE®. To persist some changes to configuration files you can use `app`, `config` and `client` properties that correspond to `$HOME/.example/config/app.toml`, `$HOME/.example/config/config.toml` and `$HOME/.example/config/client.toml`. @@ -215,15 +215,15 @@ To see which properties are available for `config.toml`, `app.toml` and `client.toml`, initialize a chain with `ignite chain init` and open the file you want to know more about. -Currently, Ignite starts only one validator node, so the first item in the +Currently, IGNITE® starts only one validator node, so the first item in the `validators` list is used (the rest is ignored). Support for multiple validators is in progress. ## Build -The `build` property lets you customize how Ignite builds your chain's binary. +The `build` property lets you customize how IGNITE® builds your chain's binary. -By default, Ignite builds the `main` package from `cmd/PROJECT_NAME/main.go`. If +By default, IGNITE® builds the `main` package from `cmd/PROJECT_NAME/main.go`. If you more than one `main` package in your project, or you have renamed the directory, use the `main` property to provide the path to the `main` Go package: @@ -232,7 +232,7 @@ build: main: cmd/hello/cmd ``` -Ignite compiles your project into a binary and uses the project's name with a +IGNITE® compiles your project into a binary and uses the project's name with a `d` suffix as name for the binary. To customize the binary name use the `binary` property: @@ -250,7 +250,7 @@ build: By default, custom protocol buffer (proto) files are located in the `proto` directory. If your project keeps proto files in a different directory, you -should tell Ignite about this: +should tell IGNITE® about this: ```yml build: @@ -310,7 +310,7 @@ the genesis file in the data directory. ## Client code generation -Ignite can generate client-side code for interacting with your chain with the +IGNITE® can generate client-side code for interacting with your chain with the `ignite generate` set of commands. Use the following properties to customize the paths where the client-side code is generated. diff --git a/docs/docs/apps/01-using-apps.md b/docs/docs/apps/01-using-apps.md index 0de25b1f1c..f10d11c3cd 100644 --- a/docs/docs/apps/01-using-apps.md +++ b/docs/docs/apps/01-using-apps.md @@ -1,14 +1,14 @@ --- -description: Using and Developing Ignite Apps +description: Using and Developing IGNITE® Apps --- -# Using Ignite Apps +# Using IGNITE® Apps -Apps offer a way to extend the functionality of the Ignite CLI. There are two +Apps offer a way to extend the functionality of the IGNITE® CLI. There are two core concepts within apps: `Commands` and `Hooks`. `Commands` extend the CLI's functionality and `Hooks` extend existing CLI command functionality. -Apps are registered in an Ignite scaffolded blockchain project through the +Apps are registered in an IGNITE® scaffolded blockchain project through the `igniteapps.yml`, or globally through `$HOME/.ignite/apps/igniteapps.yml`. To use an app within your project execute the following command inside the @@ -30,12 +30,12 @@ ignite app install -g github.com/project/cli-app The command will compile the app and make it immediately available to the `ignite` command lists. -Discover recommended Apps in the [Ignite Apps Marketplace](https://ignite.com/marketplace). +Discover recommended Apps in the [IGNITE® Apps Marketplace](https://ignite.com/marketplace). ## Listing installed apps When in an ignite scaffolded blockchain you can use the command `ignite app -list` to list all Ignite Apps and their statuses. +list` to list all IGNITE® Apps and their statuses. ## Updating apps diff --git a/docs/docs/apps/02-developing-apps.md b/docs/docs/apps/02-developing-apps.md index 935eddaaf8..dc8df4ca1e 100644 --- a/docs/docs/apps/02-developing-apps.md +++ b/docs/docs/apps/02-developing-apps.md @@ -1,8 +1,8 @@ --- -description: Using and Developing Ignite Apps +description: Using and Developing IGNITE® Apps --- -# Developing Ignite Apps +# Developing IGNITE® Apps It's easy to create an app and use it immediately in your project. First choose a directory outside your project and run: @@ -35,7 +35,7 @@ Now let's detail how to update your app's code. ## App interface -Under the hood Ignite Apps are implemented using a plugin system based on +Under the hood IGNITE® Apps are implemented using a plugin system based on `github.com/hashicorp/go-plugin`. All apps must implement a predefined interface: @@ -94,7 +94,7 @@ message Manifest { // Hooks contains the hooks that will be attached to the existing ignite commands. repeated Command commands = 3; - // Enables sharing a single app server across all running instances of an Ignite App. + // Enables sharing a single app server across all running instances of an IGNITE® App. // Useful if an app adds or extends long running commands. // // Example: if an app defines a hook on `ignite chain serve`, a server is instantiated @@ -128,7 +128,7 @@ Allowing all executing commands to share the same server instance, giving shared ## Adding new commands -App commands are custom commands added to Ignite CLI by an installed app. +App commands are custom commands added to IGNITE® CLI by an installed app. Commands can use any path not defined already by the CLI. For instance, let's say your app adds a new `oracle` command to `ignite diff --git a/docs/docs/apps/_category_.json b/docs/docs/apps/_category_.json index 5ce59790e7..d7bdaae456 100644 --- a/docs/docs/apps/_category_.json +++ b/docs/docs/apps/_category_.json @@ -1,5 +1,5 @@ { - "label": "Ignite Apps", + "label": "IGNITE® Apps", "position": 7, "link": null } diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 297d6f414b..f1fc9ae35a 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -6,8 +6,8 @@ const darkCodeTheme = require("prism-react-renderer/themes/dracula"); /** @type {import('@docusaurus/types').Config} */ const config = { - title: "Ignite Cli Docs", - tagline: "Ignite Cli Docs", + title: "IGNITE® CLI Docs", + tagline: "IGNITE® CLI Docs", url: "https://docs.ignite.com", baseUrl: "/", onBrokenLinks: "warn", @@ -89,7 +89,7 @@ const config = { image: "img/og-image.jpg", announcementBar: { content: - '← Back to Ignite', + '← Back to IGNITE®', isCloseable: false, }, docs: { @@ -100,7 +100,7 @@ const config = { navbar: { hideOnScroll: true, logo: { - alt: "Ignite Logo", + alt: "IGNITE® Logo", src: "img/header-logo-docs.svg", srcDark: "img/header-logo-docs-dark.svg", }, @@ -116,7 +116,7 @@ const config = { { href: "https://ignite.com", className: "ignt-backlink", - label: `Back to Ignite`, + label: `Back to IGNITE®`, position: "right", }, { @@ -157,11 +157,11 @@ const config = { title: "Products", items: [ { - label: "Ignite CLI", + label: "IGNITE® CLI", href: "https://ignite.com/cli", }, { - label: "Ignite Apps", + label: "IGNITE® Apps", href: "https://ignite.com/marketplace", }, ], @@ -170,7 +170,7 @@ const config = { title: "Company", items: [ { - label: "About Ignite", + label: "About IGNITE®", href: "https://ignite.com/about", }, { @@ -214,7 +214,7 @@ const config = { ], }, ], - copyright: `
© Ignite ${new Date().getFullYear()}
`, + copyright: `
© IGNITE® ${new Date().getFullYear()}
`, }, prism: { theme: lightCodeTheme, diff --git a/docs/sidebars.js b/docs/sidebars.js index 1b32a5f72f..a99bbe49a3 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -24,12 +24,12 @@ const sidebars = { items: [ { type: "link", - label: "Ignite CLI on Github", + label: "IGNITE® CLI on Github", href: "https://github.com/ignite/cli", }, { type: "link", - label: "Ignite Tutorials", + label: "IGNITE® Tutorials", href: "https://tutorials.ignite.com/", }, { diff --git a/docs/src/pages/index.js b/docs/src/pages/index.js index 461ac460b0..5bccb35b74 100644 --- a/docs/src/pages/index.js +++ b/docs/src/pages/index.js @@ -20,12 +20,12 @@ export default function Home() { return (
-

Welcome to Ignite Knowledge Hub

+

Welcome to IGNITE® Knowledge Hub

- Your one-stop portal for Ignite documentation, tutorials, and + Your one-stop portal for IGNITE® documentation, tutorials, and resources

@@ -33,23 +33,23 @@ export default function Home() {