Skip to content

docs: add cross-links between related documentation pages (#936) - #956

Merged
bradygaster merged 1 commit into
devfrom
squad/936-add-doc-cross-links
Apr 11, 2026
Merged

bradygaster merged 1 commit into
devfrom
squad/936-add-doc-cross-links

Conversation

@diberry

@diberry diberry commented Apr 10, 2026

Copy link
Copy Markdown
Contributor

Closes #936

Adds cross-references between related docs pages for improved navigation:

  • Added 'See Also' sections linking foundational concepts (Your Team, Architecture, Parallel Work, Memory & Knowledge)
  • Connected feature pages to their related concept and guide pages (Work Routing, Built-in Roles)
  • Linked guide pages to foundational concepts and SDK references
  • Linked GitHub integration to routing and team concepts

All links follow the issue's Priority 1 mapping for high-impact navigation improvements.

@diberry
diberry marked this pull request as ready for review April 10, 2026 14:59
Copilot AI review requested due to automatic review settings April 10, 2026 14:59

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds “See Also” cross-links across key docs pages to improve navigation between foundational concepts (team, architecture, parallel work, memory) and related feature/guide pages, aligning with the Priority 1 mapping in #936.

Changes:

  • Added “See Also” sections to several guide/feature/concept pages to create high-signal navigation paths.
  • Expanded the Architecture “Learn more” section to include “Your Team” and normalized some link targets to explicit .md paths.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
docs/src/content/docs/guide/build-autonomous-agent.md Adds a “See Also” section linking to core concepts and the SDK reference.
docs/src/content/docs/features/routing.md Adds “See Also” links to team, architecture, and parallel work concepts.
docs/src/content/docs/features/built-in-roles.md Adds “See Also” links connecting roles to team, architecture, and routing.
docs/src/content/docs/concepts/your-team.md Adds a “See Also” section linking to architecture, routing, parallel work, and memory.
docs/src/content/docs/concepts/parallel-work.md Adds a “See Also” section linking to team, architecture, and memory concepts.
docs/src/content/docs/concepts/memory-and-knowledge.md Adds a “See Also” section linking back to team, architecture, and parallel work.
docs/src/content/docs/concepts/github-workflow.md Adds a “See Also” section linking GitHub workflow to team, routing, and parallel work.
docs/src/content/docs/concepts/architecture.md Updates “Learn more” links to include “Your Team” and use explicit .md links.

Closes #936

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@diberry
diberry force-pushed the squad/936-add-doc-cross-links branch from 9e2a614 to 9014810 Compare April 10, 2026 16:03
@diberry

diberry commented Apr 10, 2026

Copy link
Copy Markdown
Contributor Author

✅ CI passes on fork — diberry/squad PR #148 (all checks green). Copilot review feedback addressed. Ready for human review.

@bradygaster
bradygaster merged commit 6bc32ac into dev Apr 11, 2026
tamirdresher pushed a commit that referenced this pull request Apr 21, 2026
Closes #936

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
SabreSE pushed a commit to SabreSE/squad that referenced this pull request May 7, 2026
PR github#1023 merged insider into main, but insider was behind on docs changes
that had already landed on main via dev (PRs github#989, github#953, github#955, github#956, github#906).
The merge resolution picked insider's older versions, reverting 25 docs files.

This restores all affected files from dev:
- David Pine's human-led productivity emphasis (PR github#989)
- Cross-links between related documentation (PR github#956)
- Compaction recovery, coordinator restraint, result persistence refs
- Teams async adapter migration guide
- State backends feature doc
- Search/Sidebar component updates
- Landing page content

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@bradygaster
bradygaster deleted the squad/936-add-doc-cross-links branch August 8, 2026 08:43
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: add cross-links between related documentation pages

3 participants