docs: fix authz path #22134
docs: fix authz path #22134
Conversation
lioncatte
requested review from
facundomedica,
testinginprod,
aaronc and
a team
as code owners
📝 WalkthroughWalkthroughThe changes in this pull request involve updates to the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (1)
x/auth/README.md (1)
Line range hint
114-119: Approved: Important warning about vesting accounts deprecation.The added warning provides crucial information about the deprecation of vesting accounts and the transition to
x/accounts. This is valuable for users and developers working with the Cosmos SDK.Consider adding a link to the documentation for the new
x/accountsmodule to help users transition more easily.Consider adding a link to the
x/accountsmodule documentation::::warning Vesting accounts are deprecated in favor of `x/accounts`. The creation of vesting account, using `x/auth/vesting`, is not possible since v0.52. For existing chains, importing the `x/auth/vesting module` is still required for backward compatibility purposes. +For more information on the new accounts module, see [x/accounts documentation](link-to-x-accounts-docs). :::
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
📒 Files selected for processing (1)
- x/auth/README.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
x/auth/README.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
| @@ -32,7 +32,7 @@ This module is used in the Cosmos Hub. | |||
|
|
|||
| ## Concepts | |||
|
|
|||
| **Note:** The auth module is different from the [authz module](../modules/authz/). | |||
| **Note:** The auth module is different from the [authz module](../authz/). | |||
There was a problem hiding this comment.
💡 Codebase verification
Link to authz module is incorrect
The updated link ../authz/ does not exist. Please verify and correct the path to the authz module documentation.
🔗 Analysis chain
Link correction looks good, please verify the path.
The update to the authz module link appears to be a correction. However, it's important to ensure that ../authz/ is indeed the correct path within the project structure.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Verify if the authz directory exists at the correct location
if [ -d "../authz" ]; then
echo "The ../authz/ directory exists, confirming the correctness of the updated link."
else
echo "Warning: The ../authz/ directory does not exist. Please double-check the correct path for the authz module documentation."
fi
Length of output: 274
There was a problem hiding this comment.
The original path is correct actually, change to ../authz/ will cause a bad link
- https://docs.cosmos.network/main/build/modules/authz => reachable
- https://docs.cosmos.network/main/build/authz => page not found
Something may be wrong with the Next version in https://docs.cosmos.network. In 0.50 version, ../modules/authz/ works well. But in Next version, this will render to https://docs.cosmos.network/main/build/authz which is a bad link
|
It seems that
So, does this mean that |
|
Hey! The links are working fine. It is deployed via the cosmos-sdk-docs repo, meaning this isn't using relative markdown on this repo but in the cosmos-sdk-docs repo. The website is updated once a day if there is a change in the docs on this repo. |
👀
Summary by CodeRabbit
authzmodule for clarity.x/accountsmodule.