fix: update broken deep-dive links in docs feature pages#390
fix: update broken deep-dive links in docs feature pages#390thalissonvs merged 2 commits intoautoscrape-labs:mainfrom
Conversation
📝 WalkthroughWalkthroughFixed broken documentation links across two feature documentation files by updating reference paths to match the reorganized documentation structure, including new path segments for Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 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)
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 `@docs/en/features/core-concepts.md`:
- Line 62: Replace every occurrence of the incorrect link prefix
"../../deep-dive/" with the correct "../deep-dive/" in this document; search for
the exact string "../../deep-dive/" (appearing in markdown links such as the
Browser Domain link) and update each to "../deep-dive/" so all deep-dive links
resolve to the existing docs/en/deep-dive/ targets.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 66b74ca5-2a3a-4352-9416-3df7b0d70ac8
📒 Files selected for processing (2)
docs/en/features/core-concepts.mddocs/en/features/element-finding.md
|
|
||
| !!! info "Want to Know More?" | ||
| For technical details on how the browser process is managed internally, see the [Browser Domain](../../deep-dive/browser-domain.md#browser-process-manager) deep dive. | ||
| For technical details on how the browser process is managed internally, see the [Browser Domain](../../deep-dive/architecture/browser-domain.md#browser-process-manager) deep dive. |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Check the actual location of deep-dive documentation files
echo "=== Checking for deep-dive at docs/en/deep-dive/ (requires ../ from features/) ==="
fd -t f -p 'docs/en/deep-dive/(architecture|fundamentals)' | head -5
echo ""
echo "=== Checking for deep-dive at docs/deep-dive/ (requires ../../ from features/) ==="
fd -t f -p 'docs/deep-dive/(architecture|fundamentals)' | head -5
echo ""
echo "=== Checking specific target files mentioned in PR ==="
echo "Checking with ../ pattern (docs/en/deep-dive/):"
ls -la docs/en/deep-dive/architecture/browser-domain.md 2>/dev/null && echo " ✓ Found" || echo " ✗ Not found"
ls -la docs/en/deep-dive/fundamentals/cdp.md 2>/dev/null && echo " ✓ Found" || echo " ✗ Not found"
ls -la docs/en/deep-dive/fundamentals/connection-layer.md 2>/dev/null && echo " ✓ Found" || echo " ✗ Not found"
echo ""
echo "Checking with ../../ pattern (docs/deep-dive/):"
ls -la docs/deep-dive/architecture/browser-domain.md 2>/dev/null && echo " ✓ Found" || echo " ✗ Not found"
ls -la docs/deep-dive/fundamentals/cdp.md 2>/dev/null && echo " ✓ Found" || echo " ✗ Not found"
ls -la docs/deep-dive/fundamentals/connection-layer.md 2>/dev/null && echo " ✓ Found" || echo " ✗ Not found"Repository: autoscrape-labs/pydoll
Length of output: 1004
🏁 Script executed:
#!/bin/bash
# Check element-finding.md for link patterns
echo "=== Links in element-finding.md ==="
rg -n 'deep-dive' docs/en/features/element-finding.md
echo ""
echo "=== Links in core-concepts.md ==="
rg -n 'deep-dive' docs/en/features/core-concepts.mdRepository: autoscrape-labs/pydoll
Length of output: 2288
Critical: All deep-dive links use incorrect relative path—breaks 6 links in this file.
This file uses ../../deep-dive/... (two ../ segments) throughout, but element-finding.md in the same directory correctly uses ../deep-dive/... (one ../ segment). Since both files are at docs/en/features/, they must use the same path depth. The target files exist only at docs/en/deep-dive/, confirming that ../../deep-dive/ resolves to a non-existent path.
Fix: Change all instances from ../../deep-dive/ to ../deep-dive/.
Affected lines: 62, 100, 107, 193, 457, 545
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/en/features/core-concepts.md` at line 62, Replace every occurrence of
the incorrect link prefix "../../deep-dive/" with the correct "../deep-dive/" in
this document; search for the exact string "../../deep-dive/" (appearing in
markdown links such as the Browser Domain link) and update each to
"../deep-dive/" so all deep-dive links resolve to the existing
docs/en/deep-dive/ targets.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
thanks @danishashko! |
Fixes #309
Fixes #348
Some docs pages link to deep-dive files using their old paths. After a docs reorganization the files were moved into subcategories (
architecture/andfundamentals/) but the links in the feature pages were not updated, causing 404s.core-concepts.md (issue #309):
deep-dive/browser-domain.md->deep-dive/architecture/browser-domain.mddeep-dive/connection-layer.md->deep-dive/fundamentals/connection-layer.md(2 occurrences)deep-dive/cdp.md->deep-dive/fundamentals/cdp.mdelement-finding.md (issue #348):
deep-dive/webelement-domain.md->deep-dive/architecture/webelement-domain.mdAll target files exist at the corrected paths.
Summary by CodeRabbit