Skip to content

seo: optimize titles and descriptions for all 606 docs pages#639

Merged
cdileep23 merged 53 commits intodevfrom
seo/optimize-titles-descriptions
May 7, 2026
Merged

seo: optimize titles and descriptions for all 606 docs pages#639
cdileep23 merged 53 commits intodevfrom
seo/optimize-titles-descriptions

Conversation

@Shiva-2503
Copy link
Copy Markdown

@Shiva-2503 Shiva-2503 commented May 6, 2026

Summary

Optimized `title` and `description` frontmatter across all 606 MDX documentation pages for better search visibility.

  • Titles rewritten to be keyword-rich, unique, and within ~42 chars (renders as `{title} | Future AGI Docs`, targeting ≤60 chars total)
  • Descriptions rewritten to 120–155 chars with specific feature context, replacing generic or missing fallback text
  • Eliminates duplicate titles like `Overview | Future AGI Docs` appearing on 10+ section index pages
  • Eliminates duplicate titles like `Quickstart | Future AGI Docs` appearing across multiple sections

Changes

Area Files
Admin settings 11 pages
Agent playground 6 pages
Annotations 14 pages
API reference ~140 pages
Command center ~20 pages
Cookbook ~40 pages
Dataset, error-feed, evaluation, observe, optimization, prompt, protect, prototype, quickstart, release-notes, roles, SDK, self-hosting, simulation, tracing ~375 pages

Merge status

This branch has been merged with PR #627 (fix/prism-404-redirects) and brought up to date with dev. Any conflicts between the two PRs have been resolved:

Merge order: PR #627 should merge first. After it merges to `dev`, this PR will apply cleanly (it already contains all of #627's commits).

Test plan

  • Verify page `<title>` tags are unique and descriptive in browser dev tools
  • Verify `` content is present and specific on all pages
  • Confirm no duplicate titles across section index pages
  • Check that title lengths render within 60 chars in Google search preview

🤖 Generated with Claude Code

Shibu and others added 30 commits April 30, 2026 22:50
Prism AI Gateway was renamed to Command Center (commit 6c6f22c) but
no URL redirects were added, causing 16 pages to 404.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…s, update 27 MDX files

Root causes:
- Suhani Nagpal (8c7b7f8, Mar 25): deleted 116 pages in "orphan links cleanup" without adding redirects
- hadarishav (6c6f22c, Apr 22): renamed /docs/prism/* → /docs/command-center/* without redirects

Changes:
- src/lib/redirects.ts: added 71 new redirect entries covering old prism, tracing/manual,
  observability, quickstart, prompt-workbench, and other deleted paths; fixed 47 existing
  redirect entries whose targets had themselves been deleted (chained 404s), correcting
  them to current valid pages
- 27 MDX source files: fixed broken internal href links pointing to deleted/moved paths
  (evaluation/features/groups, tracing/manual/*, observe/voice/set-up, prompt-workbench,
  optimization/optimizers/overview, and others)

Verified clean:
- 0 broken nav links
- 0 broken content links (313/313 unique internal hrefs resolve)
- 0 dead redirect targets (all 306 redirects point to real pages)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…ages

Adds two automated checks that run on every PR to dev/main:

1. audit-links.mjs — fails if any nav link or MDX content link points to
   a missing page (catches broken hrefs introduced by a PR)

2. check-deleted-pages.mjs — fails if an MDX page is deleted without a
   corresponding entry in src/lib/redirects.ts (prevents the pattern that
   caused the April 404 incident: pages deleted with no redirects)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- AiChatWidget: h3 → p for "FutureAGI AI Assistant"
- TableOfContents: h4 → p for "On this page"
- GiscusComments: h3 → p for "Questions & Discussion"
- Card: h3 → p for all card titles
- global.css: add .docs-section-title class (same styles as h2)
- 171 MDX files: ## Next Steps and ## Related → <div class="docs-section-title">

Every page H1 is now the first heading in the DOM.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…, custom-properties, guardrails, mcp-a2a)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…providers, rate-limiting, routing, self-hosted-models, shadow-experiments, streaming, webhooks, errors, troubleshooting)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…evaluate-rag, gepa, image-eval, import-datasets, index, langchain, llamaindex, meeting-summarization)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…h-eval, chat-sim, cicd, compare-optimizers, conversation-eval)

Skipped: async-batch-eval, custom-eval-metrics (already optimized)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…t-mgmt, dataset-opt, distributed-tracing, dynamic-columns, eval-driven-dev, experimentation, first-eval, hallucination, huggingface)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…se, manual-tracing, monitoring-alerts, multimodal-eval, prompt-opt, prompt-versioning, prompt-workbench, protect-guardrails, prototype)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…, text-to-sql-eval, voice-simulation, rag-langchain, simulate-sdk, text-to-sql)
…gent-testing, using-futureagi-*, dynamic-column, static-column, synthetic-data)
…-columns, add-rows, annotate, create, experiments, run-prompt, dataset-index, error-feed-concepts)
…alysis, issue-overview, linear-integration, metadata-panel, sampling, state-graph, the-feed, traces)
…, error-feed-index, answer-refusal, audio-quality, audio-transcription, bias-detection, bleu, caption-hallucination, chunk-attribution)
…lly-inappropriate-tone, clip-score, completeness, contain, contains-valid-link, context-adherence, context-relevance, conversation-coherence, conversation-resolution)
…nation, data-privacy, detect-hallucination, embedding-similarity, eval-ranking, fid-score, fuzzy-match, ground-truth-match, groundedness)
…n-adherence, builtin-index, instruction-adherence, is-code, is-concise, is-email, is-good-summary, is-harmful-advice, is-helpful)
… is-polite, lavenshtein-similarity, llm-function-calling, mrr, ndcg-at-k, no-age-bias, no-apologies, no-gender-bias)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…dance, no-invalid-links, no-llm-reference, no-racial-bias, numeric-similarity, ocr-evaluation, pii, precision-at-k, prompt-injection, recall-at-k)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…ins, sexist, summary-quality, synthetic-image-evaluator, task-completion, text-to-sql, tone, toxicity, translation-accuracy)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…emplates, eval-types, judge-models, understanding-evaluation, cicd, custom-models, custom, evaluate)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…s batch 21

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…l, pagerduty, posthog, google-adk, google-genai, langfuse, integrations-index, openai-agents)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…autogen, bedrock, crewai, dspy, google_adk, google_genai, groq, guardrails)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…va/anthropic, java/bedrock, java/cohere, java/frameworks, java-index, java/llm-providers, java/openai, java/pinecone)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…angchain, langgraph, litellm, livekit, llamaindex-workflows, llamaindex, mastra, mcp, mistralai)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…nai_agents, pipecat, portkey, promptflow, smol_agents, spring-boot, togetherai)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Shibu and others added 18 commits May 6, 2026 20:51
…ai, knowledge-base, alerts, dashboard, evals, add-attributes)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…racing, annotating-api, tool-spans, tracer-span, in-line-evals, traceai-helpers, langfuse, log-prompt-templates, mask-span)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…ssion-user-id, set-up-tracing, quickstart, session, users, voice, observe-index, optimization-concept, using-platform)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…ation-index, bayesian, gepa, meta-prompt, promptwizard, protegi, random-search, prompt-engineering, understanding-prompts)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…h, create-template, create-with-ai, folders, linked-traces, prompt-sdk, prompt-index, protect-concept, run-protect)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…nderstanding-prototype, versions-runs, choose-winner, prototype-evals, set-up-prototype, prototype-index, annotations, command-center-gateway, generate-synthetic-data)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…se-notes, roles, sdk)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…, sdk root)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…sting, simulation concepts)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…es, tracing auto)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…rumentation)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…, langchain)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…livekit, llamaindex, etc.)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…ining, tracing concepts)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…— final batch)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- process.exit(1) on git diff failure so CI surfaces the error instead of silently passing
- regex updated to match both single and double quoted redirect entries
- card title p element gets explicit text-[1.125rem] to match original h3 size

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…settings, agent-playground, annotations, api/*, command-center, cookbook, self-hosting)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@entelligence-ai-pr-reviews
Copy link
Copy Markdown

Automatic Review Skipped

Too many files for automatic review.

If you would still like a review, you can trigger one manually by commenting:

@entelligence review

Shibu and others added 5 commits May 7, 2026 16:02
Resolves one conflict in dataset/features/experiments.mdx:
- Kept dev's new tool-calling content and ## Tips section
- Preserved PR #627's <div class="docs-section-title"> pattern for Next Steps

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…sm-404-redirects and dev

Resolves 4 conflicts:
- api/call-executions/getsessioncomparison.mdx: deleted (removed in dev refactor)
- api/test-executions/getevalexplanationsummary.mdx: deleted (removed in dev refactor)
- api/test-executions/gettestexecutiondetails.mdx: kept SEO-optimized title/description from PR #639
- dataset/features/experiments.mdx: kept SEO title + dev Tips section + PR #627 div heading pattern

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Reverts the 171-file change from bae9308 that converted these sections
to <div class="docs-section-title">. Restoring them as ## headings per
team decision.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Card titles sit under ## Next Steps (h2) in the DOM, so they should
be h3, not p. Restores the heading hierarchy: h1 → h2 (Next Steps) → h3 (card title).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@cdileep23 cdileep23 changed the base branch from dev to fix/prism-404-redirects May 7, 2026 13:14
@cdileep23 cdileep23 changed the base branch from fix/prism-404-redirects to dev May 7, 2026 13:15
@cdileep23 cdileep23 merged commit 6ea420c into dev May 7, 2026
2 checks passed
@cdileep23 cdileep23 deleted the seo/optimize-titles-descriptions branch May 7, 2026 13:26
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