Skip to content

Conversation

@charliecreates
Copy link
Contributor

@charliecreates charliecreates bot commented Dec 5, 2025

Updates docs frontmatter and global layout metadata so key docs.tambo.co pages expose stronger, keyword-focused titles and meta descriptions.

Changes

  • Updated docs/content/docs/index.mdx description to highlight the MCP-native React SDK and generative UI focus on the docs homepage.
  • Added description frontmatter to high-traffic docs pages, including:
    • docs/content/docs/api-reference/react-hooks.mdx
    • docs/content/docs/best-practices/component-data-props.mdx
    • docs/content/docs/cli/index.mdx
    • docs/content/docs/cli/configuration.mdx
    • docs/content/docs/cli/global-options.mdx
    • docs/content/docs/cli/workflows.mdx
    • docs/content/docs/cli/commands/*.mdx for add, create-app, full-send, init, list, migrate, update, and upgrade.
  • Centralized the global docs description in docs/src/app/layout.tsx into a docsDescription constant and wired it into metadata.description, openGraph.description, and twitter.description.
  • Switched the canonical URL in docs/src/app/layout.tsx from a relative "./" to a root-relative "/", so Next + metadataBase emit a cleaner canonical for the docs homepage.

Verification

# Lint (monorepo via Turbo)
$ npm run lint
# → 13 lint tasks succeeded across packages; only pre-existing warnings remain

# Type-check (monorepo via Turbo)
$ npm run check-types
# → All 13 check-types tasks passed (reran after final layout.tsx change; @tambo-ai/docs recompiled cleanly)

# Tests (monorepo via Turbo)
$ npm test
# → 10 test tasks passed across packages (API, web, CLI, core, showcase, etc.)

Self-review notes (no extra changes made):

  • docs/content/docs/api-reference/react-hooks.mdx & docs/content/docs/best-practices/component-data-props.mdx: kept the new descriptions as-is even though they’re on the longer side, because they still fall within an SEO-friendly window (~144 and ~152 characters respectively) and clearly describe the page intent.
  • docs/content/docs/cli/commands/*.mdx: left the per-command descriptions slightly redundant with the CLI overview on purpose so each command page has a self-contained, action-first meta description for search results.

Refs TAM-768.

@vercel
Copy link

vercel bot commented Dec 5, 2025

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

Project Deployment Preview Comments Updated (UTC)
cloud Ready Ready Preview Comment Dec 5, 2025 11:36pm
showcase Ready Ready Preview Comment Dec 5, 2025 11:36pm
tambo-docs Ready Ready Preview Comment Dec 5, 2025 11:36pm

Copy link
Contributor Author

@charliecreates charliecreates bot left a comment

Choose a reason for hiding this comment

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

Overall, the changes are cohesive and improve SEO/metadata consistency, with a nice centralization of the docs description. The main concern is the interaction between the hard-coded production fallback for baseUrl and the now root-relative alternates.canonical, which forces canonicals to point to https://docs.tambo.co/ even in non-production deployments. All added description frontmatter entries look technically safe and consistent with the existing content structure. Addressing the canonical/base URL behavior would reduce future surprises for staging or custom-hosted docs setups.

Summary of changes

Summary of Changes

  • Added description frontmatter to multiple docs pages (React hooks reference, best practices, CLI overview, CLI configuration, global options, workflows, and each CLI command page) to provide more descriptive, SEO-friendly metadata.
  • Updated the docs homepage description in docs/content/docs/index.mdx to emphasize the MCP-native React SDK and generative UI focus.
  • Centralized the global docs description in docs/src/app/layout.tsx into a docsDescription constant and reused it for metadata.description, openGraph.description, and twitter.description.
  • Adjusted the canonical URL in the docs app layout metadata from "./" to "/" to emit a cleaner canonical homepage URL when combined with metadataBase.

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.

3 participants