Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

docs: fix inaccessible links #22147

Merged
merged 1 commit into from
Oct 7, 2024
Merged

Conversation

xiaobei0715
Copy link
Contributor

@xiaobei0715 xiaobei0715 commented Oct 7, 2024

Description

Fix inaccessible links, and modify it to a correctly accessible link
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
    • Updated the introduction of the testing guide to emphasize the importance of testing in the development cycle.
    • Revised link to the "System Tests" section for improved navigation.
    • Maintained structure and clarity around various testing types, including Unit, Integration, and System Tests, with examples included.

@xiaobei0715 xiaobei0715 requested a review from a team as a code owner October 7, 2024 11:10
Copy link
Contributor

coderabbitai bot commented Oct 7, 2024

📝 Walkthrough

Walkthrough

The pull request modifies the 16-testing.md document to enhance clarity regarding testing practices within the Cosmos SDK. It emphasizes the significance of testing throughout the development cycle and updates a link related to system tests, reflecting a potential documentation restructuring. The document retains its organization around various testing types, providing examples to assist developers in implementing effective testing strategies.

Changes

File Path Change Summary
docs/build/building-modules/16-testing.md Updated link for system tests from 06-system-tests.md to system-tests; clarified testing structure and content.

Possibly related PRs

Suggested reviewers

  • sontrinh16
  • tac0turtle

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between cc25229 and cefead2.

📒 Files selected for processing (1)
  • docs/build/building-modules/16-testing.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • docs/build/building-modules/16-testing.md

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

@xiaobei0715 xiaobei0715 changed the title docs.fix inaccessible links docs:fix inaccessible links Oct 7, 2024
@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Oct 7, 2024
@julienrbrt julienrbrt changed the title docs:fix inaccessible links docs: fix inaccessible links Oct 7, 2024
@sontrinh16 sontrinh16 added this pull request to the merge queue Oct 7, 2024
Merged via the queue into cosmos:main with commit 112e228 Oct 7, 2024
75 of 82 checks passed
mergify bot pushed a commit that referenced this pull request Oct 7, 2024
julienrbrt pushed a commit that referenced this pull request Oct 7, 2024
@xiaobei0715 xiaobei0715 deleted the cosmos-patch-241007 branch October 14, 2024 14:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants