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 URL #4142

Merged
merged 1 commit into from
Dec 23, 2024
Merged

docs: fix URL #4142

merged 1 commit into from
Dec 23, 2024

Conversation

goodfirm
Copy link
Contributor

Overview

The link has expired, replace it with the latest address

@goodfirm goodfirm requested a review from a team as a code owner December 19, 2024 08:16
@goodfirm goodfirm requested review from cmwaters and evan-forbes and removed request for a team December 19, 2024 08:16
Copy link
Contributor

coderabbitai bot commented Dec 19, 2024

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 buf (1.47.2)
specs/src/proto/types.proto

An unexpected error occurred while running buf.

specs/src/proto/wire.proto

An unexpected error occurred while running buf.

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request involves updating documentation links in two protobuf files (types.proto and wire.proto). The changes are purely cosmetic, modifying URLs to include the src directory in the path. Specifically, the documentation links for various message definitions and comments have been updated to point to a new repository structure. No changes were made to the underlying message structures, fields, or types.

Changes

File Change Summary
specs/src/proto/types.proto Updated documentation links to include src directory in URL paths
specs/src/proto/wire.proto Modified URLs for TransactionFee and MessageCommitmentAndSignature message comments

Possibly related PRs

Suggested reviewers

  • staheri14
  • ninabarbakadze
  • rootulp
  • evan-forbes

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fbffd6a and 23481e9.

📒 Files selected for processing (2)
  • specs/src/proto/types.proto (6 hunks)
  • specs/src/proto/wire.proto (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • specs/src/proto/types.proto
  • specs/src/proto/wire.proto

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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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

Copy link
Member

@ninabarbakadze ninabarbakadze left a comment

Choose a reason for hiding this comment

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

lint failing

Signed-off-by: goodfirm <[email protected]>
@goodfirm goodfirm changed the title doc: fix 404 URL docs: fix 404 URL Dec 19, 2024
@goodfirm
Copy link
Contributor Author

lint failing

The reason for the failure is that doc is not an available type, but docs is.

Modified, please review again.

@rootulp rootulp changed the title docs: fix 404 URL docs: fix URL Dec 19, 2024
@rootulp
Copy link
Collaborator

rootulp commented Dec 19, 2024

Note: you may need to run make proto-gen and push the changed files to this PR b/c I'm surprised that the docs change didn't manifest in the generated .pb.go files yet

@goodfirm
Copy link
Contributor Author

make proto-gen

image

Thank you, I executed this command, but no new files were generated

@rootulp
Copy link
Collaborator

rootulp commented Dec 20, 2024

Oh sorry, on re-read I noticed the only changes were in specs/**/*.proto files so I don't think they will result in any changed generated files. Thanks for the fix!

@rootulp rootulp enabled auto-merge (squash) December 20, 2024 02:39
@goodfirm
Copy link
Contributor Author

Oh sorry, on re-read I noticed the only changes were in specs/**/*.proto files so I don't think they will result in any changed generated files. Thanks for the fix!

My pleasure.
Thanks for your review!

@rootulp rootulp merged commit 05d1acd into celestiaorg:main Dec 23, 2024
31 checks passed
Copy link

gitpoap-bot bot commented Dec 23, 2024

Congrats, your important contribution to this open-source project has earned you a GitPOAP!

GitPOAP: 2024 Celestia Contributor:

GitPOAP: 2024 Celestia Contributor GitPOAP Badge

Head to gitpoap.io & connect your GitHub account to mint!

Learn more about GitPOAPs here.

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

Successfully merging this pull request may close these issues.

4 participants