Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Add user-centered cross-links across all documentation#5

Open
ekline[bot] wants to merge 9 commits into
main from
fix/add-cross-links-to-all-pages
Open

Add user-centered cross-links across all documentation #5
ekline[bot] wants to merge 9 commits into
main from
fix/add-cross-links-to-all-pages

Conversation

@ekline

@ekline ekline Bot commented Mar 5, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds strategic cross-linking across 76 documentation pages to eliminate navigation dead ends, following documentation cross-linking best practices (Google Developer Docs Style Guide, Rackspace, I'd Rather Be Writing).

Approach: User-centered, not blanket — each page was evaluated individually for the most appropriate cross-link strategy:

  • Inline contextual links (highest value): 13 inline links in data-mapping-in-flows.md subsection headers, 9 inline links in glossary.md definitions, and contextual links across 10 flow reference pages
  • Hub page cleanup: Removed redundant bottom sections from 6 hub/index pages with card grids; trimmed 6 hub pages to keep only cross-section links
  • Tutorial "Next steps": Converted 5 tutorials from generic "Related topics" to forward-looking "Next steps" sections
  • Structured "Related topics": Added well-curated bottom sections to ~55 leaf pages with 2-4 cross-section discovery links each

Key changes by category

Inline links added (12 files):

  • data-mapping-in-flows.md — 13 subsection headers linked to component pages
  • glossary.md — 9 term definitions linked to reference pages
  • trigger.md, connectors.md, database.md, logger.md, split.md, merge.md, flow-step-settings.md, faqs.md, connect-to-the-fastn-db.md, managing-and-using-connectors.md

Hub pages trimmed/cleaned (12 files):

  • 6 hub pages: bottom sections removed (redundant with card grids)
  • 6 hub pages: trimmed to cross-section links only

Tutorials converted to "Next steps" (5 files):

  • how-to-set-up-an-activation-flow.md, how-to-set-up-a-selection-flow.md, how-to-customize-your-authentication-flow.md, how-to-customize-your-error-notification-flow.md, setting-up-a-google-drive-to-gcs-migration-widget.md

Leaf pages with "Related topics" added (~55 files):

  • 2-4 curated cross-section links per page

Review checklist

  • All internal link paths verified (0 broken links)
  • No duplicate links within individual pages
  • Style consistency (separator + H2 heading pattern)
  • Hub pages not cluttered with redundant navigation
  • Tutorials use forward-looking "Next steps" language
  • Quality grade: A (full review pass completed)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

0 participants

AltStyle によって変換されたページ (->オリジナル) /