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: use the right link for app.go #21585

Merged
merged 4 commits into from
Sep 7, 2024
Merged

docs: use the right link for app.go #21585

merged 4 commits into from
Sep 7, 2024

Conversation

GINMEL
Copy link
Contributor

@GINMEL GINMEL commented Sep 7, 2024

As the title described

Summary by CodeRabbit

  • Documentation
    • Updated hyperlinks in documentation to direct users to the current version of the resource.
    • Clarified information regarding the implementation of the ProcessProposal handler.
    • Enhanced accuracy of documentation for application developers.
    • Added a newline character for improved file formatting.

@GINMEL GINMEL requested a review from a team as a code owner September 7, 2024 16:58
Copy link
Contributor

coderabbitai bot commented Sep 7, 2024

Walkthrough

Walkthrough

The documentation for the 01-prepare-proposal.md and 02-process-proposal.md files has been updated to reflect more accurate hyperlink references. Specifically, the URLs were changed from older versioned links to current versions, ensuring correct resource linking. Additionally, newline characters were added at the end of both files for formatting consistency.

Changes

File Path Change Summary
docs/build/abci/01-prepare-proposal.md, docs/build/abci/02-process-proposal.md Updated hyperlink references to app.go from app-go-v2 to app-go and added newline characters at the end of the files.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Documentation
    participant App

    User->>Documentation: Access `01-prepare-proposal.md`
    Documentation->>App: Link to `app.go`
    App-->>Documentation: Serve current `app.go`
    Documentation-->>User: Display updated resource

    User->>Documentation: Access `02-process-proposal.md`
    Documentation->>App: Link to `app.go`
    App-->>Documentation: Serve current `app.go`
    Documentation-->>User: Display updated resource
Loading

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 02b20f9 and 1f75296.

Files selected for processing (1)
  • docs/build/abci/01-prepare-proposal.md (2 hunks)
Files skipped from review due to trivial changes (1)
  • docs/build/abci/01-prepare-proposal.md

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

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1f75296 and bcdad3e.

Files selected for processing (1)
  • docs/build/abci/02-process-proposal.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • docs/build/abci/02-process-proposal.md

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

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between bcdad3e and 56f71e5.

Files selected for processing (1)
  • docs/build/abci/01-prepare-proposal.md (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • docs/build/abci/01-prepare-proposal.md

@GINMEL
Copy link
Contributor Author

GINMEL commented Sep 7, 2024

Thanks @julienrbrt

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

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 56f71e5 and d3c8a8c.

Files selected for processing (1)
  • docs/build/abci/02-process-proposal.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • docs/build/abci/02-process-proposal.md

@julienrbrt julienrbrt added this pull request to the merge queue Sep 7, 2024
Merged via the queue into cosmos:main with commit 95383f5 Sep 7, 2024
68 of 69 checks passed
@julienrbrt
Copy link
Member

@Mergifyio backport release/v0.52.x

Copy link
Contributor

mergify bot commented Sep 9, 2024

backport release/v0.52.x

✅ Backports have been created

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants