Skip to content

Fix broken links in readme.md - #41

Open
GeneralProtectionFault wants to merge 1 commit into
Redot-Engine:masterfrom
GeneralProtectionFault:readme_link_fix
Open

GeneralProtectionFault wants to merge 1 commit into
Redot-Engine:masterfrom
GeneralProtectionFault:readme_link_fix

Conversation

@GeneralProtectionFault

@GeneralProtectionFault GeneralProtectionFault commented Nov 2, 2026 •

Copy link
Copy Markdown
Member

This fixes 3 broken links, first of which was pointed out to us by https://github.com/dominicbytes

  • Pull request workflow
  • code style guidelines
  • official build instructions for your target platform

Note that redot-cpp-template is also broken because the repo does not exist yet.
Once it is forked, this will be resolved.

Summary by CodeRabbit

  • Documentation
    • Updated contributor guidance with links to workflow and code-style documentation.
    • Added links to platform-specific build instructions in the C++ prerequisites section.

@coderabbitai

coderabbitai Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 19e30db4-0498-4108-ada0-c6b248c62d24
Commits

Reviewing files that changed from the base of the PR and between ef6e110 and 4e35c15.

Files selected for processing: 1
  • README.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

Three links in the README now point to Redot documentation for contribution workflow, code style, and platform build instructions.

Changes: README documentation links

Layer / File(s) Summary
Update documentation links
README.md
The contribution workflow, code-style guidelines, and target-platform build instructions now link to Redot documentation.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Suggested reviewers: spartan322, bgie

Merge Risk: Minimal · up to 4e35c

The README link updates are correct and ready to merge.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main change: fixing three broken links in README.md.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches
Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

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