Skip to content

docs: fix broken link and snippet path#13462

Open
SafinWasi wants to merge 3 commits intomainfrom
docs-fix-debugging-image
Open

docs: fix broken link and snippet path#13462
SafinWasi wants to merge 3 commits intomainfrom
docs-fix-debugging-image

Conversation

@SafinWasi
Copy link
Contributor

@SafinWasi SafinWasi commented Mar 12, 2026

Prepare


Description

Target issue

closes #3386

Implementation Details

This PR also modifies mkdocs to use the current docs path as base for snippets paths.


Test and Document the changes

N/A

Please check the below before submitting your PR. The PR will not be merged if there are no commits that start with docs: to indicate documentation changes or if the below checklist is not selected.

  • I confirm that there is no impact on the docs due to the code changes in this PR.

Summary by CodeRabbit

  • Documentation

    • Fixed an image reference so the IntelliJ IDEA remote-debugging guide displays the screenshot correctly.
  • Chores

    • Updated documentation build snippet paths to include the current directory, ensuring snippets resolve correctly during site builds.

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>
@SafinWasi SafinWasi requested a review from ossdhaval March 12, 2026 02:45
@mo-auto
Copy link
Member

mo-auto commented Mar 12, 2026

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 12, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 953ee7ba-b523-4e15-8eea-ff485e923654

📥 Commits

Reviewing files that changed from the base of the PR and between 8c71e41 and c5553d4.

📒 Files selected for processing (1)
  • mkdocs.yml

📝 Walkthrough

Walkthrough

Updated a documentation image reference path in the remote debugging guide and reformatted the pymdownx.snippets.base_path setting in mkdocs.yml (kept same entries) — no runtime or code logic changes.

Changes

Cohort / File(s) Summary
Documentation Path Correction
docs/contribute/development/remote-debugging.md
Fixed image reference: changed ../assets/image-jans-remote-debug-intellij.png../../assets/image-jans-remote-debug-intellij.png.
MkDocs Snippets Configuration
mkdocs.yml
Reformatted pymdownx.snippets.base_path representation and added . to the list while preserving entries (docs, .); purely YAML formatting change.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Suggested reviewers

  • manojs1978
  • ossdhaval
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main changes: fixing a broken documentation link and correcting the snippet path configuration.
Description check ✅ Passed The description addresses the target issue (#3386) and explains the implementation details, including mkdocs configuration changes for snippet paths.
Linked Issues check ✅ Passed The PR fixes the broken remote debugging documentation link and updates the snippet path configuration to support the finalized remote debugging guide for CN installations.
Out of Scope Changes check ✅ Passed Both changes (documentation link fix and mkdocs configuration) are directly scoped to fixing the remote debugging documentation issue #3386.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs-fix-debugging-image
📝 Coding Plan
  • Generate coding plan for human review comments

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.

@mo-auto mo-auto added area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs labels Mar 12, 2026
Copy link
Contributor

@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

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@mkdocs.yml`:
- Around line 45-47: The pymdownx.snippets configuration currently sets
base_path to "." which breaks existing includes under docs/script-catalog;
update the pymdownx.snippets base_path to a list that preserves the original
resolution (for example ["docs", "."]) and keep check_paths: true so snippet
paths like those referenced from docs/script-catalog/* resolve correctly; locate
the pymdownx.snippets block in mkdocs.yml and replace base_path: . with a list
containing "docs" and "." to restore backward compatibility.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 0b04f729-9215-4c9f-8c1b-a88969a8ea8d

📥 Commits

Reviewing files that changed from the base of the PR and between 2e79ef1 and 5ae6472.

📒 Files selected for processing (2)
  • docs/contribute/development/remote-debugging.md
  • mkdocs.yml

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Instructions for remote debugging of interception script on local CN installations - Revise the draft and finalize

3 participants