Skip to content

Commit

Permalink
docs: fix typos (#3343)
Browse files Browse the repository at this point in the history
* fix typos

* fix typos

* fix typos

* fix typo

* fix typos

* fix typo

* fix typo

* fix typo

* fix typo
  • Loading branch information
omahs authored Sep 18, 2024
1 parent e9db416 commit b09f2b6
Showing 9 changed files with 17 additions and 17 deletions.
2 changes: 1 addition & 1 deletion docs/docs/delegators/delegator-faq.md
Original file line number Diff line number Diff line change
@@ -9,7 +9,7 @@ People that cannot or do not want to operate [validator nodes](../validators/ove

**Delegators share the revenue of their validators, but they also share the risks.** In terms of revenue, validators and delegators differ in that validators can apply a commission on the revenue that goes to their delegator before it is distributed. This commission is known to delegators beforehand and can only change according to predefined constraints (see [section](#choosing-a-validator) below). In terms of risk, delegators' Atoms can be slashed if their validator misbehaves. For more, see [Risks](#risks) section.

To become delegators, Atom holders need to send a ["Delegate transaction"](./delegator-guide-cli.md#sending-transactions) where they specify how many Atoms they want to bond and to which validator. A list of validator candidates will be displayed in Cosmos Hub explorers. Later, if a delegator wants to unbond part or all of their stake, they needs to send an "Unbond transaction". From there, the delegator will have to wait 3 weeks to retrieve their Atoms. Delegators can also send a "Rebond Transaction" to switch from one validator to another, without having to go through the 3 weeks waiting period.
To become delegators, Atom holders need to send a ["Delegate transaction"](./delegator-guide-cli.md#sending-transactions) where they specify how many Atoms they want to bond and to which validator. A list of validator candidates will be displayed in Cosmos Hub explorers. Later, if a delegator wants to unbond part or all of their stake, they need to send an "Unbond transaction". From there, the delegator will have to wait 3 weeks to retrieve their Atoms. Delegators can also send a "Rebond Transaction" to switch from one validator to another, without having to go through the 3 weeks waiting period.

For a practical guide on how to become a delegator, click [here](./delegator-guide-cli.md).

2 changes: 1 addition & 1 deletion docs/docs/getting-started/installation.md
Original file line number Diff line number Diff line change
@@ -33,7 +33,7 @@ sudo apt install -y make gcc build-essential

We suggest the following two ways to install Go. Check out the [official docs](https://golang.org/doc/install) and Go installer for the correct download for your operating system. Alternatively, you can install Go yourself from the command line. Detailed below are standard default installation locations, but feel free to customize.

Since the introduction of CosmWasm in Gaia v18 it is recommended to build the binaries with `CGO` enabled - simply set `CGO_ENABLED=1` in your terminal befre building the binary.
Since the introduction of CosmWasm in Gaia v18 it is recommended to build the binaries with `CGO` enabled - simply set `CGO_ENABLED=1` in your terminal before building the binary.

Building the `gaiad` binary on Windows is not supported due to [dependency issues](https://github.com/CosmWasm/wasmvm).

2 changes: 1 addition & 1 deletion docs/docs/getting-started/system-requirements.md
Original file line number Diff line number Diff line change
@@ -14,7 +14,7 @@ sidebar_position: 4

## Gaia Upgrades

The Gaia application typically needs at least 32GB RAM, for smooth operation for upgrade, as there may be lenghty migrations to perform.
The Gaia application typically needs at least 32GB RAM, for smooth operation for upgrade, as there may be lengthy migrations to perform.

If you have less than 32GB RAM, you might try creating a swapfile to swap an idle program onto the hard disk to free up memory. This can allow your machine to run the binary than it could run in RAM alone.

2 changes: 1 addition & 1 deletion docs/docs/governance/README.md
Original file line number Diff line number Diff line change
@@ -11,7 +11,7 @@ This repository provides background information on these different kinds of prop

Cosmos governance is driven by the Cosmos community, and much of the documentation in this repo was funded by the community fund itself in
[Proposal 23](https://www.mintscan.io/cosmos/proposals/23) and [Proposal 63](https://www.mintscan.io/cosmos/proposals/63).
Governance discussions happens in a number of places moderated by diverse community members, including:
Governance discussions happen in a number of places moderated by diverse community members, including:

- [Forum](http://forum.cosmos.network/)
- [Discord](https://discord.gg/interchain)
6 changes: 3 additions & 3 deletions docs/docs/governance/best-practices.md
Original file line number Diff line number Diff line change
@@ -35,13 +35,13 @@ In the first stage of this strategy, you should engage people (ideally experts)
- Are there critical flaws?
- How will this affect other projects or properties of the Hub?

You should be enagaging with key stakeholders (e.g., a large validator operator) with a few short sentences to measure their support. Here's an example:
You should be engaging with key stakeholders (e.g., a large validator operator) with a few short sentences to measure their support. Here's an example:

"We are considering a proposal for funding to work on `project`. We think it will help the Hub to `outcome`. Timeline is `x`, and we're asking for `y` amount. Do you think that this is a proposal that `large validator` may support?"

**Why a large validator?** They tend to be the de facto decision-makers on the Cosmos Hub, since their delegators also delegate their voting power. If you can establish a base layer of off-chain support, you can be more confident that it's worth proceeding to the next stage.

**Note:** Many validators will likely hesitate to commit support, and that's okay. It will be important to reassure these stakeholders that this isn't a binding a commitment. You're just canvasing the community to get a feel for whether it's worthwhile to proceed. It's also an opportunity to connect with new people and to answer their questions about what it is you're working on. It will be important for them to clearly understand why you think what you're proposing will be valuable to the Cosmos Hub, and if possible, why it will be valuable to them as long-term stakeholders.
**Note:** Many validators will likely hesitate to commit support, and that's okay. It will be important to reassure these stakeholders that this isn't a binding commitment. You're just canvasing the community to get a feel for whether it's worthwhile to proceed. It's also an opportunity to connect with new people and to answer their questions about what it is you're working on. It will be important for them to clearly understand why you think what you're proposing will be valuable to the Cosmos Hub, and if possible, why it will be valuable to them as long-term stakeholders.

If you're already confident about your idea, [skip to Stage 2](#stage-2-your-draft-proposal).

@@ -110,7 +110,7 @@ An example of a successful community spend proposal is [Proposal #63](https://fo
1. Funding - amount and denomination proposed eg. 5000 ATOM.
- The entity controlling the account receiving the funding.
- Consider an itemized breakdown of funding per major deliverable.
- Note that the 'budget' of a spend proposal is generally the easiest thing to criticize. If your budget is vague, consider explaining the reasons you're unable to give a detailed breakdown and be clear about what happens if you do not meet you budget.
- Note that the 'budget' of a spend proposal is generally the easiest thing to criticize. If your budget is vague, consider explaining the reasons you're unable to give a detailed breakdown and be clear about what happens if you do not meet your budget.
1. Deliverables and timeline - the specifics of what you're delivering and how, and what to expect.
- What are the specific deliverables? (be detailed).
- When will each of these be delivered?
8 changes: 4 additions & 4 deletions docs/docs/governance/formatting.md
Original file line number Diff line number Diff line change
@@ -19,7 +19,7 @@ Text proposals are used by delegators to agree to a certain strategy, plan, comm

There are four components:

1. **Title** - the distinguishing name of the proposal, typically the way the that explorers list proposals
1. **Title** - the distinguishing name of the proposal, typically the way that explorers list proposals
2. **Summary** - the body of the proposal that further describes what is being proposed and details surrounding the proposal
3. **Deposit** - the amount that will be contributed to the deposit (in micro-ATOMs "uatom") from the account submitting the proposal
4. **Metadata** - usually a link to an off-chain resource
@@ -46,8 +46,8 @@ You must submit the proposal using `gaiad tx gov submit-proposal <path_to_text_p

There are five (5) components:

1. **Title** - the distinguishing name of the proposal, typically the way the that explorers list proposals
2. **Sumamary** - the body of the proposal that further describes what is being proposed and details surrounding the proposal
1. **Title** - the distinguishing name of the proposal, typically the way that explorers list proposals
2. **Summary** - the body of the proposal that further describes what is being proposed and details surrounding the proposal
3. **Recipient** - the Cosmos Hub (bech32-based) address that will receive funding from the Community Pool
4. **Amount** - the amount of funding that the recipient will receive in micro-ATOMs (uatom)
5. **Deposit** - the amount that will be contributed to the deposit (in micro-ATOMs "uatom") from the account submitting the proposal
@@ -97,7 +97,7 @@ You can update these CosmosHub modules using `submit-legacy-proposal`:

For `param-change` proposals, there are arguably seven (7) components, though three are nested beneath 'Changes':

1. **Title** - the distinguishing name of the proposal, typically the way the that explorers list proposals
1. **Title** - the distinguishing name of the proposal, typically the way that explorers list proposals
2. **Description** - the body of the proposal that further describes what is being proposed and details surrounding the proposal
3. **Changes** - a component containing
1. **Subspace** - the Cosmos Hub module with the parameter that is being changed
4 changes: 2 additions & 2 deletions docs/docs/governance/proposal-types/community-pool-spend.md
Original file line number Diff line number Diff line change
@@ -20,7 +20,7 @@ Cosmos Hub launched with community-spend capabilities on December 11, 2019, effe

Though the rate of funding is currently fixed at 2% of staking rewards, the effective rate is dependent upon the Cosmos Hub's staking rewards, which can change with inflation and block times.

The current paramater `Community Tax` parameter of 2% may be modified with a governance proposal and enacted immediately after the proposal passes.
The current parameter `Community Tax` parameter of 2% may be modified with a governance proposal and enacted immediately after the proposal passes.

### How much money is in the Community Pool?

@@ -42,7 +42,7 @@ The prevailing assumption is that funds should be spent in a way that brings val

- retroactive grants
- price negotiation
- fund disbursal (eg. payments in stages; payments pegged to reduce volitiliy)
- fund disbursal (eg. payments in stages; payments pegged to reduce volatility)
- radical overhaul of how the community-spend mechanism functions

We can expect this to take shape as proposals are discussed, accepted, and rejected by the Cosmos Hub community.
6 changes: 3 additions & 3 deletions docs/docs/governance/submitting.md
Original file line number Diff line number Diff line change
@@ -70,12 +70,12 @@ Available proposals that can be submitted using this Tx are:
You can read more about submitting a legacy proposal in the [cosmos-sdk docs](https://docs.cosmos.network/v0.47/build/modules/gov#submit-legacy-proposal)

#### Proposals (cosmos-sdk >= v0.47)
These proposals can are submitted using `gaiad tx gov submit-proposal`.
These proposals can be submitted using `gaiad tx gov submit-proposal`.

Using `gaiad tx gov draft-proposal` can help prepare a proposal. The tool will create a file containing the specified proposal message and it also helps with populating all the required proposal fields.
You can always edit the file after you create it using `draft-proposal`

Most cosmos-sdk modules allow changing their governance gated parameters using a `MsgUpdateParams` which is a new way of updating governance parameters. It is important to note that `MsgUpdateParams` requires **all paramaters to be specified** in the proposal message.
Most cosmos-sdk modules allow changing their governance gated parameters using a `MsgUpdateParams` which is a new way of updating governance parameters. It is important to note that `MsgUpdateParams` requires **all parameters to be specified** in the proposal message.

You can read more about submitting a proposal in the [cosmos-sdk docs](https://docs.cosmos.network/v0.47/build/modules/gov#submit-proposal)

@@ -84,7 +84,7 @@ You can read more about submitting a proposal in the [cosmos-sdk docs](https://d
Please note that cosmoshub-4 uses a minimum initial deposit amount.
:::

Proposals cannot be submitted successfully without providing a minimum initial deposit. In practice, this means that the `deposit` field in your proposal has to meet the `min_initial_deposit` governance paramter.
Proposals cannot be submitted successfully without providing a minimum initial deposit. In practice, this means that the `deposit` field in your proposal has to meet the `min_initial_deposit` governance parameter.
The minimum deposit is equal to `min_deposit * min_initial_deposit_ratio`. Only `uatom` is supported as deposit denom.
```shell
// checking the min_initial_deposit
2 changes: 1 addition & 1 deletion docs/docs/interchain-security/README.md
Original file line number Diff line number Diff line change
@@ -17,7 +17,7 @@ Validators inside the top-N percent of voting power are required to validate the
e.g. `top-95` means that the 95% of the validators (by voting power) are required to run the consumer chain binary

### Opt-in consumer chains
Only validators that opt to running a consumer chains are required to run the chain binary and become eiligible for consumer chain rewards distribution.
Only validators that opt to running a consumer chains are required to run the chain binary and become eligible for consumer chain rewards distribution.

### New consumer chain parameters

0 comments on commit b09f2b6

Please sign in to comment.