Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

fix: fix broken link #23737

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: fix broken link #23737

wants to merge 1 commit into from

Conversation

hungdinh82
Copy link

@hungdinh82 hungdinh82 commented Feb 21, 2025

Description

Closes: #XXXX


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...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers 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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Documentation
    • Removed multiple external reference links from architectural, security, state sync, and upgrade guides.
    • Updated hyperlinks to the Cosmos Whitepaper in governance, slashing, and staking documentation to direct users to the correct page.
    • Streamlined content by eliminating extraneous resource pointers, simplifying guidance throughout the documentation.

@hungdinh82 hungdinh82 requested a review from a team as a code owner February 21, 2025 05:38
Copy link
Contributor

coderabbitai bot commented Feb 21, 2025

📝 Walkthrough

Walkthrough

This pull request updates multiple documentation files by removing or updating external reference links. Changes include the deletion of URL references to blog posts, external articles, and additional guides, as well as corrections to the Cosmos Whitepaper URL. No modifications affect functionality, structure, or public entity declarations.

Changes

File(s) Summary of Change
docs/architecture/README.md, docs/architecture/adr-019-protobuf-state-encoding.md, docs/architecture/adr-029-fee-grant-module.md Removed external reference links: blog posts and articles on ADR, alternative protocols, and fee grant module details.
docs/build/building-apps/04-security-part-1.md Removed the reference to a Medium article on Go map iteration internals.
store/snapshots/README.md, store/v2/snapshots/README.md Removed references and bullet points linking to external resources related to Cosmos SDK state sync configuration.
tools/cosmovisor/CHANGELOG.md Removed a sentence referring users to the README for a complete feature list in version v0.1.0.
x/gov/README.md, x/slashing/README.md, x/staking/README.md Updated the Cosmos Whitepaper URLs from /about/whitepaper to /whitepaper.
x/upgrade/README.md Removed a bullet point linking to an external blog post about Cosmos blockchain upgrades.

Suggested labels

T:Docs, backport/v0.52.x

Suggested reviewers

  • julienrbrt
  • tac0turtle
  • akhilkumarpilli

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
tools/cosmovisor/CHANGELOG.md (1)

168-169: Broken Link Removal and Sentence Enhancement:
The removal of the broken link referencing the README file (previously included in the v1.0.0 entry) has been handled appropriately, which resolves the link issue described in the PR. Additionally, the new sentence

  "This is the first release and we started this changelog on 2021-07-01."

contains two independent clauses that would benefit from a comma before "and" for improved readability. Consider revising it to:

  "This is the first release, and we started this changelog on 2021-07-01."

🧰 Tools
🪛 LanguageTool

[uncategorized] ~168-~168: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... - 2021-08-06 This is the first release and we started this changelog on 2021-07-01...

(COMMA_COMPOUND_SENTENCE)

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0a98b65 and 1fa2545.

📒 Files selected for processing (11)
  • docs/architecture/README.md (0 hunks)
  • docs/architecture/adr-019-protobuf-state-encoding.md (0 hunks)
  • docs/architecture/adr-029-fee-grant-module.md (0 hunks)
  • docs/build/building-apps/04-security-part-1.md (1 hunks)
  • store/snapshots/README.md (0 hunks)
  • store/v2/snapshots/README.md (0 hunks)
  • tools/cosmovisor/CHANGELOG.md (1 hunks)
  • x/gov/README.md (1 hunks)
  • x/slashing/README.md (1 hunks)
  • x/staking/README.md (1 hunks)
  • x/upgrade/README.md (0 hunks)
💤 Files with no reviewable changes (6)
  • docs/architecture/adr-029-fee-grant-module.md
  • x/upgrade/README.md
  • store/snapshots/README.md
  • docs/architecture/adr-019-protobuf-state-encoding.md
  • docs/architecture/README.md
  • store/v2/snapshots/README.md
✅ Files skipped from review due to trivial changes (4)
  • x/slashing/README.md
  • x/gov/README.md
  • x/staking/README.md
  • docs/build/building-apps/04-security-part-1.md
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.md`: "Assess the documentation for misspellings, gramm...

**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

  • tools/cosmovisor/CHANGELOG.md
🪛 LanguageTool
tools/cosmovisor/CHANGELOG.md

[uncategorized] ~168-~168: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... - 2021-08-06 This is the first release and we started this changelog on 2021-07-01...

(COMMA_COMPOUND_SENTENCE)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: main
  • GitHub Check: Summary

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant