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 broken links #940

Merged
merged 1 commit into from
Oct 10, 2024
Merged

docs: fix broken links #940

merged 1 commit into from
Oct 10, 2024

Conversation

thephez
Copy link
Contributor

@thephez thephez commented Oct 2, 2024

Issue being fixed or feature implemented

A couple links pointed to non-existent docs

What was done?

Changed links to point to directory instead

How Has This Been Tested?

Locally

Breaking Changes

N/A

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have made corresponding changes to the documentation

For repository code-owners and collaborators only

  • I have assigned this pull request to a milestone

Summary by CodeRabbit

  • Documentation
    • Updated links in the README for Architectural Decision Records (ADRs) and Request For Comments (RFCs) to improve navigation.
    • Minor formatting adjustments for better readability.

Copy link
Contributor

coderabbitai bot commented Oct 2, 2024

Walkthrough

The pull request involves modifications to the README.md file for the Tenderdash project. Key changes include updates to links in the "Contributing" section that now direct to directories instead of specific files, enhancing navigation. Additionally, minor formatting adjustments were made, such as removing an extra space before a section header. The overall focus is on improving link accessibility and document organization.

Changes

File Change Summary
README.md - Updated links for Architectural Decision Records (ADRs) and Request For Comments (RFCs) to point to directories instead of specific README files.
- Minor formatting adjustments, including removal of extra space before "Join us" section header.

Possibly related PRs

  • docs: update readme #934: The changes in this PR also involve updates to the README.md file, specifically in the "Contributing" section, which aligns with the main PR's focus on improving link accessibility and document organization.

Suggested reviewers

  • shumkov
  • lklimek
  • QuantumExplorer

🐰 In the README, changes were made,
Links now lead where paths are laid.
No more files to misdirect,
Just tidy links we can respect.
Join us now, hop in the fun,
With clearer paths, we’ve just begun! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 8468fc6 and 0822a57.

📒 Files selected for processing (1)
  • README.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • README.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.

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.

@lklimek lklimek merged commit a44a35f into dashpay:v1.3-dev Oct 10, 2024
6 checks passed
@thephez thephez deleted the readme-link-fix branch October 10, 2024 13:05
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.

3 participants