Skip to content

Fix: docs sidebar anchors#1914

Closed
er-mene wants to merge 3 commits intounclecode:developfrom
er-mene:fix/docs-sidebar-anchor
Closed

Fix: docs sidebar anchors#1914
er-mene wants to merge 3 commits intounclecode:developfrom
er-mene:fix/docs-sidebar-anchor

Conversation

@er-mene
Copy link
Copy Markdown

@er-mene er-mene commented Apr 11, 2026

Summary

Fixed a systematic offset in the Table of Contents (TOC) within the "Browser Crawler Configuration" documentation. The issue caused sidebar links to navigate to incorrect sections due to automatic anchor ID mismatches. By adding explicit IDs to the headers, the navigation is now stable and accurate.

Fixes: None (Internal documentation improvement)

List of files changed and why

docs/md_v2/core/browser-crawler-config.md: Added explicit anchor IDs (e.g., {: #browser-config-key-fields }) to several headers to resolve cascading TOC displacement and ensure consistent deep-linking.

How Has This Been Tested?

-[x] Local Build: Ran mkdocs serve locally to compile the documentation and verify the rendering.
-[x] Browser Verification: Tested the navigation. While there is a minor visual offset when scrolling upwards (likely due to the site's sticky header overlap, which is a global CSS behavior), the logic is now correct: each TOC link now maps to the intended section instead of being displaced to unrelated parts of the document.

Checklist:

  • [ x ] My code follows the style guidelines of this project
  • [ x ] I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • [ x ] I have made corresponding changes to the documentation
  • I have added/updated unit tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

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.

2 participants