Skip to content

docs: unify guide subsection overviews on card grids#402

Merged
pratyush618 merged 3 commits into
masterfrom
docs/guides-overview-cards
Jul 10, 2026
Merged

docs: unify guide subsection overviews on card grids#402
pratyush618 merged 3 commits into
masterfrom
docs/guides-overview-cards

Conversation

@pratyush618

@pratyush618 pratyush618 commented Jul 10, 2026

Copy link
Copy Markdown
Collaborator

Every /{sdk}/guides/{section} overview page now uses the same Card-grid format.

Before

Subsection index pages were a mix: most were Markdown tables (| Guide | Description |), the two workflows indexes used Card grids, and the integrations indexes were grouped bullet lists. The top-level Python guides overview was also missing a card for its Dashboard subsection.

After

  • Converted all ~24 subsection index pages (core, reliability, operations, workflows, resources, observability, extensibility, integrations, advanced-execution) across Python / Node / Java to <Cards> grids — one <Card> per child page with a one-line gloss, order preserved.
  • integrations pages keep their ## Observability / ## Web frameworks groupings, each with its own grid.
  • Added the missing Dashboard card to the Python guides overview, and an "In this section" grid to the Python dashboard index (surfaces the previously-unlinked SSO page).
  • Dropped redundant fumadocs-ui Card/Callout imports — those components are globally registered.

Verification

  • pnpm build — all pages compile and prerender; spot-checked rendered HTML (e.g. /python/guides/core = 8 cards, /node/guides/integrations keeps both group headings).
  • pnpm run typecheck clean.

Summary by CodeRabbit

  • Documentation
    • Updated Java, Node.js, and Python guide landing pages with card-based navigation for improved browsing.
    • Preserved existing guide links and descriptions across core, extensibility, integrations, observability, operations, reliability, resources, workflows, and advanced execution sections.
    • Added a Dashboard entry to the Python guides overview.
    • Added Dashboard subsection links for Authentication, SSO, task and queue overrides, and the REST API.

Subsection overviews were a mix of Markdown tables, grouped bullet lists, and (workflows only) Card grids. Unify all on the Card-grid format so every /{sdk}/guides/{section} lands on a consistent link+gloss overview. Drop redundant fumadocs Card/Callout imports (globally registered).
@github-actions github-actions Bot added the docs label Jul 10, 2026
@coderabbitai

coderabbitai Bot commented Jul 10, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 40837cb5-4e3e-4b2f-a403-654d7e725e0a

📥 Commits

Reviewing files that changed from the base of the PR and between 013a1ab and 4f49e8a.

📒 Files selected for processing (26)
  • docs/content/docs/java/guides/core/index.mdx
  • docs/content/docs/java/guides/extensibility/index.mdx
  • docs/content/docs/java/guides/integrations/index.mdx
  • docs/content/docs/java/guides/observability/index.mdx
  • docs/content/docs/java/guides/operations/index.mdx
  • docs/content/docs/java/guides/reliability/index.mdx
  • docs/content/docs/java/guides/resources/index.mdx
  • docs/content/docs/node/guides/core/index.mdx
  • docs/content/docs/node/guides/extensibility/index.mdx
  • docs/content/docs/node/guides/integrations/index.mdx
  • docs/content/docs/node/guides/observability/index.mdx
  • docs/content/docs/node/guides/operations/index.mdx
  • docs/content/docs/node/guides/reliability/index.mdx
  • docs/content/docs/node/guides/resources/index.mdx
  • docs/content/docs/node/guides/workflows/index.mdx
  • docs/content/docs/python/guides/advanced-execution/index.mdx
  • docs/content/docs/python/guides/core/index.mdx
  • docs/content/docs/python/guides/dashboard/index.mdx
  • docs/content/docs/python/guides/extensibility/index.mdx
  • docs/content/docs/python/guides/index.mdx
  • docs/content/docs/python/guides/integrations/index.mdx
  • docs/content/docs/python/guides/observability/index.mdx
  • docs/content/docs/python/guides/operations/index.mdx
  • docs/content/docs/python/guides/reliability/index.mdx
  • docs/content/docs/python/guides/resources/index.mdx
  • docs/content/docs/python/guides/workflows/index.mdx
💤 Files with no reviewable changes (1)
  • docs/content/docs/node/guides/workflows/index.mdx

📝 Walkthrough

Walkthrough

Guide navigation across Java, Node, and Python documentation is converted from Markdown tables or lists to MDX Cards and Card layouts. Python also adds Dashboard navigation, while redundant component imports are removed from selected pages.

Changes

Guide navigation card migration

Layer / File(s) Summary
Java guide card navigation
docs/content/docs/java/guides/*/index.mdx
Java guide indexes now render navigation through Cards and Card components while preserving destinations and descriptions.
Node guide card navigation
docs/content/docs/node/guides/*/index.mdx
Node guide indexes use card-based navigation, and redundant MDX imports are removed from the workflows page.
Python guide card navigation
docs/content/docs/python/guides/*/index.mdx
Python guide indexes use card-based navigation, including new Dashboard cards and updated dashboard section navigation.

Estimated code review effort: 2 (Simple) | ~15 minutes

Possibly related PRs

Suggested labels: docs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: standardizing guide subsection overview pages into card-grid layouts.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/guides-overview-cards

Comment @coderabbitai help to get the list of available commands.

@pratyush618
pratyush618 merged commit b8d1863 into master Jul 10, 2026
14 checks passed
@pratyush618
pratyush618 deleted the docs/guides-overview-cards branch July 10, 2026 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant