Skip to content

Fix README docker link #474

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

Open
wants to merge 2 commits into
base: development
Choose a base branch
from
Open

Conversation

GGoetzelmann
Copy link

@GGoetzelmann GGoetzelmann commented Aug 11, 2025

Link initially contained an escaped slash, resulting in a 404 error
Afaik package has been moved from base-repo/base-repo to base-repo. Link reflects that now.

Summary by CodeRabbit

  • Documentation
    • Fixed Docker container links in README by removing URL-encoded segments (base-repo%2Fbase-repo → base-repo) in Getting Started and More Information sections.
    • Improves readability and ensures links resolve correctly when navigating setup resources.
    • Clarifies setup guidance for new users.
    • No changes to functionality, configuration, or runtime behavior.

Fix 404 error on link to docker image
Copy link

coderabbitai bot commented Aug 11, 2025

Walkthrough

The README.md was updated to correct Docker container links by removing URL-encoded path segments, changing base-repo%2Fbase-repo to base-repo in two sections. No code, configuration, or behavior changes were made.

Changes

Cohort / File(s) Summary of Changes
Docs
README.md
Fixed two Docker links by replacing URL-encoded base-repo%2Fbase-repo with base-repo; documentation-only text/link correction.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I nibbled on links with a hop and a blink,
Unknotting the slashes that made readers think.
From percenty tangles to paths clean and true,
The README now sparkles like morning dew.
Thump-thump! says the rabbit—onward we brew.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix_readme_dockerlink

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
  • 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 explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this 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.

@GGoetzelmann GGoetzelmann changed the base branch from main to development August 11, 2025 09:34
Copy link

@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: 1

🧹 Nitpick comments (1)
README.md (1)

104-104: Optional: add a copy-paste Docker pull/run snippet

Consider adding a short example to help users quickly pull the image:

# Pull from GitHub Container Registry
docker pull ghcr.io/kit-data-manager/base-repo:latest

# Run (adjust ports/env as needed)
docker run --rm -p 8080:8080 ghcr.io/kit-data-manager/base-repo:latest
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b9d2321 and 8eab905.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🔇 Additional comments (1)
README.md (1)

104-104: LGTM: broken Docker link fixed

The container link now correctly points to github.com/kit-data-manager/base-repo/pkgs/container/base-repo and resolves the 404. Good catch.

@@ -101,7 +101,7 @@ What you now have to do before you start the microservice is to place additional

* [Getting Started & Documentation](https://kit-data-manager.github.io/webpage/base-repo/index.html)
* [API documentation](https://kit-data-manager.github.io/webpage/base-repo/documentation/api-docs.html)
* [Docker container](https://github.com/kit-data-manager/base-repo/pkgs/container/base-repo%2Fbase-repo)
* [Docker container](https://github.com/kit-data-manager/base-repo/pkgs/container/base-repo)
Copy link

Choose a reason for hiding this comment

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

💡 Verification agent

❓ Verification inconclusive

Summary mismatch: only one visible change

The AI summary mentions two locations updated; the annotated diff shows a single changed line. Please confirm whether the badge link earlier in the README was also changed in this PR or was already correct.

You can verify remaining occurrences of the old, URL-encoded path with:


🏁 Script executed:

#!/bin/bash
# Find any lingering encoded references in the repo
rg -n "base-repo%2Fbase-repo|pkgs/container/base-repo%2Fbase-repo" -S

Length of output: 71


Correction: only one Docker container link updated
The only change in this PR is the Docker container link at README.md:104—no earlier badge link was modified and no URL-encoded paths remain. Please update the PR summary to reflect that a single link was updated.

  • Location needing summary update: README.md line 104
🤖 Prompt for AI Agents
In README.md around line 104, the PR summary incorrectly suggests multiple
badge/link changes; the only change is the Docker container link. Update the PR
summary (or PR description) to state that a single Docker container link at
README.md:104 was updated, remove any mention of other badge or URL-encoded path
changes, and ensure the summary references the exact file and line (README.md
line 104) for clarity.

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.

1 participant