Skip to content

improvement(docs): simplify navigation and share editor previews - #7606

Merged
waleedlatif1 merged 2 commits into
stagingfrom
codex/docs-sidebar-navigation
Sep 8, 2026
Merged

improvement(docs): simplify navigation and share editor previews#7606
waleedlatif1 merged 2 commits into
stagingfrom
codex/docs-sidebar-navigation

Conversation

@waleedlatif1

@waleedlatif1 waleedlatif1 commented Sep 8, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Make sidebar section names open their overview pages, nest credential guides under their integrations, and align sidebar rows, scrolling, and mobile navigation with the platform.
  • Reuse the editor's shared workflow sentences, icon tiles, and variable formatter in docs illustrations. Preserve diagram fitting, dragged positions, keyboard inspection, and dialog focus.
  • Fix long titles overlapping page actions with a shared responsive header. Improve API reference controls, trim repetitive content, correct examples, and regenerate the affected references.
  • Reuse relevant guide images and add 21 explicitly auto-generated English caption tracks to Academy videos.

Type of Change

  • Bug fix
  • Improvement

Testing

  • Production build, app/docs/renderer type checks, and 285 focused tests passed.
  • Cleanup, full lint, block-registry validation, all 46 repository audits, and docs-manifest validation passed.
  • Audited 698 generated pages, 23,625 internal links, and 181 rendered images with no broken internal links, fragments, or missing images.
  • Manually tested section switching, nested guides, API controls, theme switching, mobile navigation, captions, and workflow inspection. Verified 104 responsive header layouts, 94 diagram/theme states, and desktop/mobile dragging without geometry regressions.
  • Lighthouse: 14 production lab runs; performance 76–84 mobile and 98–100 desktop, with Best Practices and SEO at 100. The combined accessibility sweep covers 1,394 page/theme states: 1,356 scored 100; 38 scored 96–97 for the shared editor's existing orange/green role badge contrast. Header checks scored 100.

The shared workflow badge palette remains below WCAG AA text contrast to preserve editor parity. Caption tracks are labeled auto-generated and have not had a complete human listening review. Semantic search backend testing is excluded.

Checklist

  • Code follows project style guidelines
  • Self-reviewed my changes
  • Tests added/updated and passing
  • No new warnings introduced — shared workflow badge contrast is documented above
  • I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

@waleedlatif1
waleedlatif1 requested a review from a team as a code owner September 8, 2026 20:38
@vercel

vercel Bot commented Sep 8, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Sep 8, 2026 9:18pm UTC

Request Review

@waleedlatif1

Copy link
Copy Markdown
Collaborator Author

@greptile

@waleedlatif1

Copy link
Copy Markdown
Collaborator Author

@cubic-dev-ai review this PR

@cubic-dev-ai

cubic-dev-ai Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

@cubic-dev-ai review this PR

@waleedlatif1 I have started the AI code review. It will take a few minutes to complete.

@waleedlatif1

Copy link
Copy Markdown
Collaborator Author

@greptile-apps

@greptile-apps

greptile-apps Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

The PR appears safe to merge, with no outstanding findings.

Summary

  • Simplifies desktop and mobile navigation, nests integration credential guides, and introduces responsive page headers.
  • Shares workflow rendering, icon, sentence, and reference-formatting behavior between the editor and documentation previews.
  • Improves API reference accessibility and content, updates generated references, and adds caption tracks to Academy videos.
  • The change since the previous review restores authored workflow focus by de-emphasizing surrounding block borders and type badges while retaining full text contrast.

Diagram

%%{init: {'theme': 'neutral'}}%%
flowchart LR
  Definition[Authored workflow definition] --> Conversion[toReactFlowElements]
  Focus[Highlighted or inspected element] --> Conversion
  Conversion --> Blocks[Documentation block nodes]
  Conversion --> Containers[Documentation container nodes]
  Conversion --> Edges[Workflow edges]
  Blocks --> SharedRenderer[Shared workflow renderer]
  Containers --> SharedRenderer
  SharedRenderer --> Preview[Interactive documentation preview]
Loading

Comment thread apps/docs/components/workflow-preview/docs-block-node.tsx
@waleedlatif1

Copy link
Copy Markdown
Collaborator Author

@greptile-apps

@waleedlatif1
waleedlatif1 merged commit 7e9dd2a into staging Sep 8, 2026
41 checks passed
@waleedlatif1
waleedlatif1 deleted the codex/docs-sidebar-navigation branch September 8, 2026 21:20
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.

1 participant