Skip to content

Fix docs link in copilot #6145

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Sep 11, 2025
Merged

Fix docs link in copilot #6145

merged 1 commit into from
Sep 11, 2025

Conversation

ShaharNaveh
Copy link
Collaborator

@ShaharNaveh ShaharNaveh commented Sep 10, 2025 •
edited by coderabbitai bot
Loading

fixes #6144

Summary by CodeRabbit

  • Documentation
    • Updated documentation links to use root-relative paths for consistent navigation across environments.
    • Prevents broken or context-dependent links and improves reliability when browsing docs from different locations.
    • No functional changes to the application; this update only affects documentation link targets.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 10, 2025 •
edited
Loading

Walkthrough

Updated two documentation links in .github/copilot-instructions.md from relative to root-relative paths. No code or behavior changes.

Changes

Cohort / File(s) Summary of Changes
Documentation link targets
.github/copilot-instructions.md		 Changed two links from architecture/architecture.md to /architecture/architecture.md and from DEVELOPMENT.md to /DEVELOPMENT.md; anchor text unchanged.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks (5 passed)

✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title concisely describes the main change of fixing a documentation link in the Copilot instructions file and is directly aligned with the PR’s modifications.
Linked Issues Check ✅ Passed The changes update both broken links in .github/copilot-instructions.md to correct root-relative paths, directly addressing the missing architecture and development guide links reported in issue #6144.
Out of Scope Changes Check ✅ Passed The PR only modifies the links in .github/copilot-instructions.md and does not introduce any unrelated files or code changes, so no out-of-scope modifications are present.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

Poem

I nibbled links with careful bite,
Hop-hop—now paths resolve just right.
From burrowed docs to root I bound,
No “file not found,” just solid ground.
A tidy trail for future sight. 🐇✨

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

📜 Recent review details

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7044d43 and 5ae4755.

📒 Files selected for processing (1)
  • .github/copilot-instructions.md (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-07-19T03:16:56.511Z 
Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-19T03:16:56.511Z
Learning: Check the architecture document (`architecture/architecture.md`) for a high-level overview

Applied to files:

  • .github/copilot-instructions.md
📚 Learning: 2025-07-19T03:16:56.511Z 
Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-19T03:16:56.511Z
Learning: Generate documentation with `cargo doc --no-deps --all`

Applied to files:

  • .github/copilot-instructions.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)
  • GitHub Check: Check the WASM package and demo
  • GitHub Check: Run snippets and cpython tests (windows-latest)
  • GitHub Check: Run snippets and cpython tests on wasm-wasi
  • GitHub Check: Run rust tests (macos-latest)
  • GitHub Check: Run rust tests (windows-latest)
  • GitHub Check: Run snippets and cpython tests (macos-latest)
  • GitHub Check: Run rust tests (ubuntu-latest)
  • GitHub Check: Run snippets and cpython tests (ubuntu-latest)
  • GitHub Check: Check Rust code with rustfmt and clippy
  • GitHub Check: Ensure compilation on various targets
  • GitHub Check: Run tests under miri
🔇 Additional comments (1)
.github/copilot-instructions.md (1)

209-213: Correct fix: switch to repo-root relative links to resolve 404s from .github context

From a file under .github, plain relative paths would resolve under .github/… and 404. Prefixing with “/” makes them relative to the repository root (per GitHub docs), and both targets exist on main: /architecture/architecture.md and /DEVELOPMENT.md. Looks good. (docs.github.com, github.com)

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

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@youknowone youknowone added the skip:ci Skip running the ci label Sep 11, 2025
@youknowone youknowone merged commit 0c3d14a into RustPython:main Sep 11, 2025
11 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@youknowone youknowone youknowone approved these changes

Assignees
No one assigned
Labels
skip:ci Skip running the ci
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Missing 'architecture' and 'development guide' files in copilot-instructions.md
2 participants
@ShaharNaveh @youknowone