Skip to content

fix: update broken deep-dive links in docs feature pages#390

Merged
thalissonvs merged 2 commits intoautoscrape-labs:mainfrom
danishashko:fix/broken-docs-links
Apr 2, 2026
Merged

fix: update broken deep-dive links in docs feature pages#390
thalissonvs merged 2 commits intoautoscrape-labs:mainfrom
danishashko:fix/broken-docs-links

Conversation

@danishashko
Copy link
Copy Markdown
Contributor

@danishashko danishashko commented Apr 1, 2026

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/ and fundamentals/) 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.md
  • deep-dive/connection-layer.md -> deep-dive/fundamentals/connection-layer.md (2 occurrences)
  • deep-dive/cdp.md -> deep-dive/fundamentals/cdp.md

element-finding.md (issue #348):

  • deep-dive/webelement-domain.md -> deep-dive/architecture/webelement-domain.md

All target files exist at the corrected paths.

Summary by CodeRabbit

  • Documentation
    • Updated internal documentation links to reference reorganized reference materials, improving navigation to in-depth learning resources on architecture and fundamentals.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 1, 2026

📝 Walkthrough

Walkthrough

Fixed broken documentation links across two feature documentation files by updating reference paths to match the reorganized documentation structure, including new path segments for /fundamentals/ and /architecture/ directories.

Changes

Cohort / File(s) Summary
Documentation Link Updates
docs/en/features/core-concepts.md, docs/en/features/element-finding.md
Updated internal documentation links to reference new deep-dive documentation paths with added path segments (/architecture/, /fundamentals/) and corrected file extensions from .md to directory references.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Hoppity-hop through docs so grand,
Fixed broken links across the land,
Paths now point where they should go,
Documentation's all aglow! 🌟

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: fixing broken documentation links in feature pages after a docs reorganization.
Description check ✅ Passed The PR description provides clear context about the broken links, lists specific files and paths being updated, and references the linked issues (#309 and #348) addressing the problems.
Linked Issues check ✅ Passed All code changes directly address the requirements in linked issues #309 and #348: broken documentation links are updated to use correct paths after docs reorganization.
Out of Scope Changes check ✅ Passed All changes are in-scope documentation link updates matching the objectives in issues #309 and #348; no unrelated modifications are present.
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

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.

Copy link
Copy Markdown

@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 `@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

📥 Commits

Reviewing files that changed from the base of the PR and between d422ebe and 71fa969.

📒 Files selected for processing (2)
  • docs/en/features/core-concepts.md
  • docs/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.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 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.md

Repository: 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
Copy link
Copy Markdown

codecov Bot commented Apr 1, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@thalissonvs
Copy link
Copy Markdown
Member

thanks @danishashko!

@thalissonvs thalissonvs merged commit 07f4d9a into autoscrape-labs:main Apr 2, 2026
12 checks passed
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.

[Docs]: Broken link in "element-finding" documentation page [Docs]: links in !!! tip boxes give 404 errors

2 participants