Conversation
Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughUpdated a documentation image reference path in the remote debugging guide and reformatted the Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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. Comment |
There was a problem hiding this comment.
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
📒 Files selected for processing (2)
docs/contribute/development/remote-debugging.mdmkdocs.yml
Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>
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.Summary by CodeRabbit
Documentation
Chores