Skip to content

docs: add See Also cross-links to tool and config pages - #397

Closed
laserduor wants to merge 1 commit into
bytebase:mainfrom
laserduor:docs/see-also-links
Closed

docs: add See Also cross-links to tool and config pages#397
laserduor wants to merge 1 commit into
bytebase:mainfrom
laserduor:docs/see-also-links

Conversation

@laserduor

Copy link
Copy Markdown
Contributor

Summary

Add a consistent `See Also` section to three pages that end abruptly after their main content and lack cross-references to related topics:

  • `docs/tools/explain-sql.mdx`
  • `docs/tools/health-check.mdx`
  • `docs/config/debug.mdx`

Change

Each page gains a short list of links to existing pages (`execute_sql`, `search_objects`, `custom-tools`, `toml`, `command-line`). All targets verified to exist in the current docs tree — no broken links.

Why

  • These pages are discoverable only from the sidebar; readers arriving via search have no way to reach related topics
  • The other tool pages (`execute_sql`, `search_objects`) already follow this pattern
  • Docs-only, no behavior change

…g pages

Add consistent cross-references to related tool and configuration pages.
Links point only to pages that exist in the current docs tree.
@tianzhou

tianzhou commented Aug 8, 2026

Copy link
Copy Markdown
Member

This doesn't show much added value.

@tianzhou tianzhou closed this Aug 8, 2026
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