Fixing pages related to group admins #543
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
📝 WalkthroughWalkthroughThis pull request updates the privileged policies documentation. It revises the referenced Cosmos SDK module version from v0.46 to v0.50 and changes the URL for the observer module parameters to now point to authority policies. Additionally, the generic policy account names ("Group1" and "Group2") have been replaced with three specific names ("groupEmergency", "groupOperational", and "groupAdmin") to clarify the permission levels associated with the underlying privileged policy account. No alterations were made to exported or public entity declarations. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
src/pages/developers/architecture/privileged.mdx (1)
43-47: LGTM! Consider minor formatting improvements.The explanation of policy account naming is clear and informative. It effectively communicates that the names indicate permission levels rather than actual group associations.
Consider this minor formatting improvement for better readability:
- Notice that policy accounts below are called "groupEmergency", "groupOperational", "groupAdmin". These are just names that indicate the level of - permissions and are not related to the actual groups associated with policy accounts. As you can see in testnet there are three entries - that both point to the same policy account. This means that right now even though there are three - levels of permissions ("groupEmergency", "groupOperational", "groupAdmin") there is only one policy account that is authorized to perform - privileged actions. + Notice that policy accounts below are called "groupEmergency", "groupOperational", and "groupAdmin". + These are just names that indicate the level of permissions and are not related to the actual groups + associated with policy accounts. As you can see in testnet, there are three entries that point to + the same policy account. This means that right now, even though there are three levels of permissions + ("groupEmergency", "groupOperational", "groupAdmin"), there is only one policy account that is + authorized to perform privileged actions.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/pages/developers/architecture/privileged.mdx(2 hunks)
🧰 Additional context used
🪛 LanguageTool
src/pages/developers/architecture/privileged.mdx
[typographical] ~24-~24: It appears that a comma is missing.
Context: ...ups. Anyone can create a group. In this document we only consider policy accounts that g...
(DURING_THAT_TIME_COMMA)
[duplication] ~28-~28: Possible typo: you repeated a word.
Context: ...icy accounts are defined in the [params of of the observer module](https://zetachain-...
(ENGLISH_WORD_REPEAT_RULE)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: build
- GitHub Check: Analyze (javascript)
🔇 Additional comments (1)
src/pages/developers/architecture/privileged.mdx (1)
28-29: Verify the authority policies endpoint accessibility.Let's confirm that the new endpoint is accessible and returns the expected policy data.
✅ Verification successful
🏁 Script executed:
#!/bin/bash # Description: Check if the authority policies endpoint is accessible curl -s "https://zetachain-athens.blockpi.network/lcd/v1/public/zeta-chain/authority/policies" | jq '.'Length of output: 572
Authority policies endpoint verified successfully.
The endpoint athttps://zetachain-athens.blockpi.network/lcd/v1/public/zeta-chain/authority/policiesis accessible and returns the expected JSON structure with the policy data. No changes are needed.🧰 Tools
🪛 LanguageTool
[duplication] ~28-~28: Possible typo: you repeated a word.
Context: ...icy accounts are defined in the [params of of the observer module](https://zetachain-...(ENGLISH_WORD_REPEAT_RULE)
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
src/pages/developers/architecture/privileged.mdx (1)
28-29:⚠️ Potential issueFix the duplicated word.
-These "special" policy accounts are defined in the [params of of the observer +These "special" policy accounts are defined in the [params of the observer🧰 Tools
🪛 LanguageTool
[duplication] ~28-~28: Possible typo: you repeated a word.
Context: ...icy accounts are defined in the [params of of the observer module](https://zetachain-...(ENGLISH_WORD_REPEAT_RULE)
🧹 Nitpick comments (2)
src/pages/developers/architecture/privileged.mdx (2)
38-38: Enhance the endpoint reference with example response.Consider adding a brief example of the response format to help users understand what information they can expect from this endpoint.
42-46: Improve readability of the policy account explanation.The current text is a bit verbose and could be structured better. Consider this revision:
- Notice that policy accounts below are called "groupEmergency", "groupOperational", "groupAdmin". These are just names that indicate the level of - permissions and are not related to the actual groups associated with policy accounts. As you can see in testnet there are three entries - that both point to the same policy account. This means that right now even though there are three - levels of permissions ("groupEmergency", "groupOperational", "groupAdmin") there is only one policy account that is authorized to perform - privileged actions. + The policy accounts are named "groupEmergency", "groupOperational", and "groupAdmin" to indicate their permission levels. These names are not related + to actual group associations. In the testnet, all three permission levels currently map to the same policy account, meaning a single policy account + is authorized to perform all privileged actions.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/pages/developers/architecture/privileged.mdx(2 hunks)
🧰 Additional context used
🪛 LanguageTool
src/pages/developers/architecture/privileged.mdx
[typographical] ~24-~24: It appears that a comma is missing.
Context: ...ups. Anyone can create a group. In this document we only consider policy accounts that g...
(DURING_THAT_TIME_COMMA)
[duplication] ~28-~28: Possible typo: you repeated a word.
Context: ...icy accounts are defined in the [params of of the observer module](https://zetachain-...
(ENGLISH_WORD_REPEAT_RULE)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build
🔇 Additional comments (1)
src/pages/developers/architecture/privileged.mdx (1)
21-22: Update to the latest stable Cosmos SDK version.The link currently points to v0.50 documentation, but Cosmos SDK v0.52.x (Olympus) is now the latest stable version. Consider updating the link to reflect this:
-module](https://docs.cosmos.network/v0.50/modules/group/). +module](https://docs.cosmos.network/v0.52/modules/group/).
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
src/pages/developers/architecture/privileged.mdx (1)
21-23: Cosmos SDK Module Reference Update:
The link now points tohttps://docs.cosmos.network/v0.50/modules/group/, reflecting the change from the older v0.46 reference. Please verify that v0.50 is the intended version for your documentation. If the current stable release is v0.52 (as recent external information suggests), consider updating the reference accordingly.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/pages/developers/architecture/privileged.mdx(2 hunks)
🧰 Additional context used
🪛 LanguageTool
src/pages/developers/architecture/privileged.mdx
[typographical] ~24-~24: It appears that a comma is missing.
Context: ...ups. Anyone can create a group. In this document we only consider policy accounts that g...
(DURING_THAT_TIME_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: build
- GitHub Check: Analyze (javascript)
🔇 Additional comments (3)
src/pages/developers/architecture/privileged.mdx (3)
28-30: Policy Accounts URL and Typo Resolution:
The description now clearly defines the special policy accounts and correctly points to the authority policies endpoint athttps://zetachain-athens.blockpi.network/lcd/v1/public/zeta-chain/authority/policies. Additionally, the previously flagged duplicate "of" typographical error has been resolved.
38-38: Privileged Messaging Endpoint Update:
The endpoint for querying which policy accounts can send privileged messages has been updated tohttps://zetachain-athens.blockpi.network/lcd/v1/public/zeta-chain/authority/authorizations. Please ensure that this URL is correct and reflects the current API specifications.
42-46: Clarification on Policy Account Naming:
The alert now explicitly explains that the policy accounts are labeled as "groupEmergency", "groupOperational", and "groupAdmin" to denote varying permission levels—even though they reference the same underlying account. This added clarity benefits the reader.
Fixing changes related the the group admins making it clear what they are and how they work.
Summary by CodeRabbit