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

fix: markdown links #3778

Merged
merged 1 commit into from
Aug 13, 2024
Merged

fix: markdown links #3778

merged 1 commit into from
Aug 13, 2024

Conversation

rootulp
Copy link
Collaborator

@rootulp rootulp commented Aug 12, 2024

Fixes a few broken links. See failing CI.

Testing

make markdown-link-check passes locally

@rootulp rootulp self-assigned this Aug 12, 2024
@rootulp rootulp requested review from liamsi and a team as code owners August 12, 2024 18:37
@rootulp rootulp requested review from staheri14 and evan-forbes and removed request for a team August 12, 2024 18:37
Copy link
Contributor

coderabbitai bot commented Aug 12, 2024

Walkthrough

Walkthrough

The recent changes involve renaming terminology in the documentation related to the Celestia consensus network. The term "full consensus nodes" has been simplified to "consensus nodes" for clarity. Additionally, specific URLs for documentation have been updated to point to exact commits, enhancing user navigation. Overall, these modifications aim to simplify language and improve access to relevant resources without altering the underlying functionality of the software.

Changes

Files Change Summary
README.md, tools/blocktime/readme.md Updated terminology from "full consensus nodes" to "consensus nodes" and revised documentation references for clarity.
specs/src/specs/namespace.md Modified URL to point to a specific commit for the namespace implementation, enhancing clarity.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Documentation
    participant Node

    User->>Documentation: Access updated documentation
    Documentation->>Node: Provides info on starting a consensus node
    Node->>User: User starts a consensus node with RPC endpoint
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:

‼️ 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 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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@celestia-bot celestia-bot requested a review from a team August 12, 2024 18:38
Copy link
Member

@evan-forbes evan-forbes left a comment

Choose a reason for hiding this comment

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

🙏

@rootulp rootulp merged commit a049c57 into celestiaorg:main Aug 13, 2024
35 of 36 checks passed
@rootulp rootulp added the backport:v2.x PR will be backported automatically to the v2.x branch upon merging label Aug 20, 2024
mergify bot pushed a commit that referenced this pull request Aug 20, 2024
Fixes a few broken links. See [failing
CI](https://github.com/celestiaorg/celestia-app/actions/runs/10354113554/job/28658603156).

## Testing

`make markdown-link-check` passes locally

(cherry picked from commit a049c57)

# Conflicts:
#	specs/src/specs/namespace.md
rootulp added a commit that referenced this pull request Aug 21, 2024
Fixes a few broken links. See [failing
CI](https://github.com/celestiaorg/celestia-app/actions/runs/10354113554/job/28658603156).

## Testing

`make markdown-link-check` passes locally<hr>This is an automatic
backport of pull request #3778 done by [Mergify](https://mergify.com).

---------

Co-authored-by: Rootul P <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:v2.x PR will be backported automatically to the v2.x branch upon merging
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants