docs: Various link and content updates #2986
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mmulji-ic
requested review from
alexanderbez,
zmanian,
crodriguezvega,
jackzampolin and
a team
as code owners
|
Should run this through the markdown link checker before merging to make sure that all nits have been fixed. |
@mmulji-ic Still failing https://github.com/cosmos/gaia/actions/runs/8203120601/job/22435298975 |
Will check again, seems definitely some existing working links are failing. Have added another PR to check mdx files. The links I checked seem to be working, might need to tweak the markdown checker config some more. |
MSalopek
force-pushed
the
mmulji-ic/fix-broken-links-in-docs-2
branch
from
98db3b9 to
6e7f30b
Compare
mpoke
requested changes
May 14, 2024
mpoke
approved these changes
May 16, 2024
| @@ -121,7 +121,7 @@ Please note that `feeCoins` does not contain zero coins. The fee coins are split | |||
|
|
|||
| ### Fee Checks in `DeliverTx` | |||
| Implementing fee checks within the `DeliverTx` function introduces a few requirements: | |||
| - **Deterministic Minimum Fee Requirement**: For the `DeliverTx` process, it is essential to have a deterministic minimum fee requirement. In `CheckTx`, fee is checked by the `CombinedFeeRequirement(globalFees, localFees)`, which considers both `minimum-gas-prices` from `config/app.toml` and `MinimumGasPricesParam` from the globalfee Params (For more details, see [globalfee.md](/modules/globalfee.md)). `CombinedFeeRequirement` contains non-deterministic part: `minimum-gas-prices` from `app.toml`. Therefore, `CombinedFeeRequirement` cannot be used in `DeliverTx`. In `DeliverTx`, only `MinimumGasPricesParam` in globalfee Params is used for fee verification. The code implementation is shown below. | |||
| - **Deterministic Minimum Fee Requirement**: For the `DeliverTx` process, it is essential to have a deterministic minimum fee requirement. In `CheckTx`, fee is checked by the `CombinedFeeRequirement(globalFees, localFees)`, which considers both `minimum-gas-prices` from `config/app.toml` and `MinimumGasPricesParam` from the globalfee Params (For more details, see [globalfee](../../modules/globalfee)). `CombinedFeeRequirement` contains non-deterministic part: `minimum-gas-prices` from `app.toml`. Therefore, `CombinedFeeRequirement` cannot be used in `DeliverTx`. In `DeliverTx`, only `MinimumGasPricesParam` in globalfee Params is used for fee verification. The code implementation is shown below. | |||
There was a problem hiding this comment.
Link without the .md or .mdx extensions don't work for me in GH.
Suggested change
| - **Deterministic Minimum Fee Requirement**: For the `DeliverTx` process, it is essential to have a deterministic minimum fee requirement. In `CheckTx`, fee is checked by the `CombinedFeeRequirement(globalFees, localFees)`, which considers both `minimum-gas-prices` from `config/app.toml` and `MinimumGasPricesParam` from the globalfee Params (For more details, see [globalfee](../../modules/globalfee)). `CombinedFeeRequirement` contains non-deterministic part: `minimum-gas-prices` from `app.toml`. Therefore, `CombinedFeeRequirement` cannot be used in `DeliverTx`. In `DeliverTx`, only `MinimumGasPricesParam` in globalfee Params is used for fee verification. The code implementation is shown below. | |
| - **Deterministic Minimum Fee Requirement**: For the `DeliverTx` process, it is essential to have a deterministic minimum fee requirement. In `CheckTx`, fee is checked by the `CombinedFeeRequirement(globalFees, localFees)`, which considers both `minimum-gas-prices` from `config/app.toml` and `MinimumGasPricesParam` from the globalfee Params (For more details, see [globalfee](../../modules/globalfee.md)). `CombinedFeeRequirement` contains non-deterministic part: `minimum-gas-prices` from `app.toml`. Therefore, `CombinedFeeRequirement` cannot be used in `DeliverTx`. In `DeliverTx`, only `MinimumGasPricesParam` in globalfee Params is used for fee verification. The code implementation is shown below. |
| @@ -162,4 +162,4 @@ The introduction of FeeDecorator has replaced the usage of `MempoolFeeDecorator` | |||
|
|
|||
| ## References | |||
|
|
|||
| * [Documentation of the globalfee module](/modules/globalfee.md) | |||
| * [Documentation of the globalfee module](../../modules/globalfee) | |||
There was a problem hiding this comment.
ditto
Suggested change
| * [Documentation of the globalfee module](../../modules/globalfee) | |
| * [Documentation of the globalfee module](../../modules/globalfee.md) |
| order: 4 | ||
| --- | ||
|
|
||
| This Cosmos Hub educational documentation aims to outline the Hub's parameters, describe their functions, and describe the potential implications of modifying each parameter. This documentation also aims to provide guidelines for creating and assessing parameter-change proposals. | ||
| This documentation also aims to provide guidelines for creating and assessing parameter-change proposals. |
There was a problem hiding this comment.
Suggested change
| This documentation also aims to provide guidelines for creating and assessing parameter-change proposals. | |
| This documentation aims to provide guidelines for creating and assessing parameter-change proposals. |
|
|
||
| Drafting and submitting a parameter-change governance proposal involves two kinds of risk: losing proposal deposit amounts and the potential to alter the function of the Cosmos Hub network in an undesirable way. | ||
|
|
||
| ## What parameters can be changed? | ||
|
|
||
| The complete parameters of the Cosmos Hub are split up into different modules, each of which has its own set of parameters. Any of them can be updated with a Param Change Proposal. If you are technically inclined, this is the full [list of modules](https://github.com/cosmos/cosmos-sdk/tree/master/x) in the Cosmos SDK. The Cosmos Hub is built using the Cosmos SDK, but not all available modules are in use on the Hub. | ||
| The complete parameters of the Cosmos Hub are split up into different modules, each of which has its own set of parameters. Most module's parameters can be updated by submitting a governance proposal. |
There was a problem hiding this comment.
Suggested change
| The complete parameters of the Cosmos Hub are split up into different modules, each of which has its own set of parameters. Most module's parameters can be updated by submitting a governance proposal. | |
| The complete parameters of the Cosmos Hub are split up into different modules, each of which has its own set of parameters. Most parameters can be updated by submitting a governance proposal. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Closes: #XXXX
Fixes a number of broken links and updates some content where services are no longer available.
Removed historic proposals which do not need to be maintained in the current set of docs.
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
docs:prefix in the PR titleReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...
docs:prefix in the PR title