Skip to content

docs: wire nav-wave-1564 pages into navigation - #1580

Merged
bradygaster merged 5 commits into
devfrom
squad/nav-wave-1564
Aug 3, 2026
Merged

bradygaster merged 5 commits into
devfrom
squad/nav-wave-1564

Conversation

@bradygaster

Copy link
Copy Markdown
Collaborator

Summary

Wires the eight pages merged by #1565–#1568 content PRs into the shared docs/src/navigation.ts sidebar and corrects the test fixtures that tracked the guide/reference/scenario/feature counts.

Related to #1564

#1569 remains parked (platform stability gate not met per design review).


Page Map

Page Section Nav Entry
guide/agent-framework-integration.md Guides Agent Framework Integration
features/security-hardening.md Security (new section) Security Hardening
scenarios/azure-container-apps.md Scenarios Azure Container Apps
scenarios/aks-deployment.md Scenarios AKS Deployment
scenarios/production-observability.md Scenarios Production Observability
scenarios/production-troubleshooting.md Scenarios Production Troubleshooting
reference/container-image.md Reference Container Image
reference/state-backend-selection.md Reference State Backend Selection

Design contract followed: integration page in Guides, security in new dedicated Security section, infrastructure/cloud pages in Scenarios, reference material in Reference.


Test Fixtures Updated

  • test/docs-build.test.ts: Added agent-framework-integration to EXPECTED_GUIDES (fixes count mismatch), added container-image + state-backend-selection to EXPECTED_REFERENCE, added four new scenario slugs to EXPECTED_SCENARIOS, added security-hardening to EXPECTED_FEATURES.
  • All 22 docs-build.test.ts tests pass locally with these changes.

Validation

  • vitest run test/docs-build.test.ts — ✅ 22/22 pass
  • No orphan pages: all 8 new pages have nav entries
  • No dead slugs: all slugs verified against existing .md files in docs/src/content/docs/
  • TypeScript deprecation warning in docs/tsconfig.json is pre-existing (baseUrl); not introduced by this PR
  • Astro build and link checks will run in CI (corporate npm registry blocked for local installs)

Working as PAO (DevRel)

bradygaster and others added 5 commits July 24, 2026 09:42
- Merged 5 pending decisions from .squad/decisions/inbox to .squad/decisions.md:
  - 2026-03-26: CI deletion guard and source tree canary (Booster)
  - 2026-03-26: Copilot git safety rules (RETRO)
  - 2026-03-29: Versioning Policy (Flight)
  - 2026-04-25: Release Process Skill Update (Booster)
  - 2026-06-24: Restore always-on coordinator inline-dispatch gate (Procedures)

- Added orchestration logs for Flight, FIDO, RETRO, Surgeon agents
  (Session: 2026-07-24T09:20:10.011Z)

- Added session log: locked PR merge strategy for 17 open PRs

- Deleted merged inbox files (.squad/decisions/inbox/*)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add eight merged docs pages to navigation.ts in their canonical sections:
- Guides: Agent Framework Integration (guide/agent-framework-integration)
- Security (new section): Security Hardening (features/security-hardening)
- Scenarios: Azure Container Apps, AKS Deployment, Production Observability,
  Production Troubleshooting
- Reference: Container Image, State Backend Selection

Fix guide count mismatch and expand EXPECTED_GUIDES, EXPECTED_REFERENCE,
EXPECTED_SCENARIOS, and EXPECTED_FEATURES in test/docs-build.test.ts so
all 8 new pages are covered and no orphan pages remain.

Related to #1564

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI lite review requested due to automatic review settings August 3, 2026 04:06
@github-actions

github-actions Bot commented Aug 3, 2026 •

Copy link
Copy Markdown
Contributor

🛫 PR Readiness Check

ℹ️ This comment updates on each push. Last checked: commit d1bd0e6

PR Scope: 🔧 Infrastructure

⚠️ 3 item(s) to address before review

Status Check Details
❌ Single commit 5 commits — consider squashing before review
✅ Not in draft Ready for review
✅ Branch up to date Up to date with dev
❌ Copilot review No Copilot review yet — it may still be processing
✅ Changeset present No source files changed — changeset not required
✅ Scope clean No .squad/ or docs/proposals/ files
✅ No merge conflicts No merge conflicts
❌ Copilot threads resolved 1 unresolved Copilot thread(s) — fix and resolve before merging
✅ CI passing All checks passing

Files Changed (2 files, +21 −2)

File +/−
docs/src/navigation.ts +14 −0
test/docs-build.test.ts +7 −2

Total: +21 −2


This check runs automatically on every push. Fix any ❌ items and push again.
See CONTRIBUTING.md and PR Requirements for details.

@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

🟡 Impact Analysis — PR #1580

Risk tier: 🟡 MEDIUM

📊 Summary

Metric Count
Files changed 2
Files added 0
Files modified 2
Files deleted 0
Modules touched 2

🎯 Risk Factors

  • 2 files changed (≤5 → LOW)
  • 2 modules touched (2-4 → MEDIUM)

📦 Modules Affected

docs (1 file)
  • docs/src/navigation.ts
tests (1 file)
  • test/docs-build.test.ts

This report is generated automatically for every PR. See #733 for details.

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

Wires the nav-wave-1564 docs pages into the docs site sidebar (docs/src/navigation.ts) and updates test/docs-build.test.ts fixtures so the Astro build tests correctly expect the new guide/reference/scenario/feature slugs.

Changes:

  • Added the new Guide, Scenarios, Reference, and Feature slugs to the docs-build fixture expectations.
  • Added navigation entries for the new pages, including a new “Security” sidebar section.
Show a summary per file
File Description
test/docs-build.test.ts Updates expected slug fixtures so docs build output checks include the eight newly added pages.
docs/src/navigation.ts Adds sidebar entries for the new pages and introduces a new “Security” nav section.

Review details

  • Files reviewed: 2/2 changed files
  • Comments generated: 1
  • Review effort level: Lite

Comment thread docs/src/navigation.ts
Comment on lines +104 to +110
{
title: 'Security',
dir: 'features',
items: [
{ title: 'Security Hardening', slug: 'features/security-hardening' },
],
},
@bradygaster

Copy link
Copy Markdown
Collaborator Author

✅ Handbook Review — APPROVE TO MERGE

Reviewed as: Handbook (SDK Usability)


Navigation Placement

Page Section Verdict
`guide/agent-framework-integration.md` Guides (4th, after Recipes) ✅ Correct section; ordering acceptable
`features/security-hardening.md` Security (new section) ✅ Warranted dedicated section
`scenarios/azure-container-apps.md` Scenarios ✅ Correct
`scenarios/aks-deployment.md` Scenarios ✅ Correct
`scenarios/production-observability.md` Scenarios ✅ Correct
`scenarios/production-troubleshooting.md` Scenarios ✅ Correct
`reference/container-image.md` Reference (before Glossary) ✅ Correct
`reference/state-backend-selection.md` Reference (before Glossary) ✅ Correct

Reader Journey

Get Started → Concepts → Core/Advanced Features → Infrastructure → Guides → Security → Scenarios → Reference. Cohesive. Security after Guides and before Scenarios is the right location — developers integrate first, harden second, then deploy.

Slug Resolution

All 102 nav slugs resolve to existing `.md` files on disk. Zero orphans. Zero dead slugs.

Duplicate / Orphan Entries

None. Each of the 8 new pages gets exactly one nav entry.

#1571/#1573 Nav Preserved

No regressions. Infrastructure section, concepts entries, and get-started changes from those PRs are intact in this diff.

New Security Section Warranted?

Yes. A single-item "Security" section is intentionally sparse now but the section header immediately signals discoverability to users seeking hardening guidance. dir: 'features' is accurate (file lives at features/security-hardening.md). The section is expected to grow with future pages.

Test Fixtures

EXPECTED_GUIDES +1, EXPECTED_REFERENCE +2, EXPECTED_SCENARIOS +4, EXPECTED_FEATURES +1 — all accurate and match merged pages.

CI Status

All blocking checks green. test job in-progress (tests executing; build already passed). Scope Boundary skipped (no scope violation). Mergeable: ✅ MERGEABLE.


APPROVE TO MERGE. Ship it.

@bradygaster
bradygaster merged commit a3d4891 into dev Aug 3, 2026
16 checks passed
@bradygaster
bradygaster deleted the squad/nav-wave-1564 branch August 20, 2026 07:51
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