Skip to content

[Documentation] Parameters & Authorizations#1182

Merged
Olshansk merged 11 commits into
mainfrom
update_param_docs
Apr 8, 2025
Merged

[Documentation] Parameters & Authorizations#1182
Olshansk merged 11 commits into
mainfrom
update_param_docs

Conversation

@Olshansk

@Olshansk Olshansk commented Apr 7, 2025

Copy link
Copy Markdown
Contributor

- Note: This came up as a result of reviewing #1173

Summary

Restructure upgrade documentation and add module authorization details

Primary Changes:

  • Renamed and reordered upgrade documentation files with numeric prefixes for better organization
  • Added new 3_module_auth.md file with governance authorization details
  • Restructured params documentation, moving from module_params.md to a more comprehensive 1_intro_to_params.md

Secondary changes:

  • Fixed relative path references across documentation files
  • Updated heading formats from # to ## in several files
  • Modified TODO comments from TODO_MAINNET to TODO_MAINNET_MIGRATION
  • Updated file path reference in docusaurus params generation script

Type of change

Select one or more from the following:

@Olshansk Olshansk self-assigned this Apr 7, 2025
@Olshansk Olshansk added the documentation Improvements or additions to documentation label Apr 7, 2025
@Olshansk Olshansk added this to Shannon Apr 7, 2025
@Olshansk Olshansk moved this to 👀 In review in Shannon Apr 7, 2025
@Olshansk Olshansk added this to the Morse to Shannon Migration milestone Apr 7, 2025
* pokt/main:
  [Morse -> Shannon Migration] Add `waive_morse_claim_gas_fees` param (#1173)
  [Code Health] chore: enable reviewdog on all PRs (#1188)
  [Tooling] chore: add buf registry name & update deps (#1174)
  [TxClient] Add configurable transaction fee options to enhance transaction flexibility (#1175)
  Update pocketd_cli.md (#1184)
  [Quick PR] change beta rpc url in the docs (#1183)

@bryanchriswhite bryanchriswhite left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Olshansk! 🙌

Preemptively approving. 🚀

Comment thread docusaurus/docs/protocol/governance/1_intro_to_params.md Outdated
Comment thread docusaurus/docs/protocol/governance/1_intro_to_params.md Outdated
Comment thread docusaurus/docs/protocol/governance/1_intro_to_params.md Outdated
Comment thread docusaurus/docs/protocol/governance/1_intro_to_params.md Outdated
3. **Testing**: Thorough testing of the proposed changes is conducted in devnet and testnet environments before mainnet deployment.
4. **Announcement**: Upon successful testing, we announce the upgrade through our social media channels and community forums.
5. **Deployment**: An upgrade transaction is sent to the network, allowing node operators using [Cosmovisor](../../operate/walkthroughs/full_node_walkthrough.md) to automatically upgrade their nodes at the specified block height.
5. **Deployment**: An upgrade transaction is sent to the network, allowing node operators using [Cosmovisor](../walkthroughs/full_node_walkthrough.md) to automatically upgrade their nodes at the specified block height.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Were these links broken previously?

Wdyt about an issue (I don't mind opening it) to automate broken link checking?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wdyt about an issue (I don't mind opening it) to automate broken link checking?

It is already be done by our docuseries CI.

Not sure how it got through.

Comment thread docusaurus/docs/operate/upgrades/3_module_auth.md Outdated
Comment thread docusaurus/docs/operate/upgrades/3_module_auth.md Outdated
Comment thread docusaurus/docs/operate/upgrades/3_module_auth.md Outdated
Comment thread docusaurus/docs/operate/upgrades/3_module_auth.md Outdated
Comment thread docusaurus/docs/operate/upgrades/3_module_auth.md Outdated
Olshansk and others added 7 commits April 8, 2025 12:16
@Olshansk Olshansk merged commit 367b9f5 into main Apr 8, 2025
@github-project-automation github-project-automation Bot moved this from 👀 In review to ✅ Done in Shannon Apr 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

2 participants