Skip to content

docs: remove the Smart Routing page and its references - #103

Merged
hMED22 merged 2 commits into
mainfrom
ahmednemdil/eng-135-pull-smart-routing-docs
Sep 1, 2026
Merged

docs: remove the Smart Routing page and its references#103
hMED22 merged 2 commits into
mainfrom
ahmednemdil/eng-135-pull-smart-routing-docs

Conversation

@hMED22

@hMED22 hMED22 commented Sep 1, 2026

Copy link
Copy Markdown
Member

Removes the Smart Routing documentation. The @edenai router is no longer documented, so the page is deleted and /v3/llms/smart-routing redirects to /v3/llms/provider-routing, the closest surviving page.

What changed

Deleted

  • v3/llms/smart-routing.mdx and its nav entry, with a redirect added in docs.json.

Reference cleanup

  • request-metadata: dropped the auto field from the sample response and the field table, the auto strategy row, the "When Eden AI chose the model" section, and the related use-case bullet.
  • provider-routing: removed the Info block contrasting the two pages, and the routing.quality_cost cross-link.
  • embeddings: the best-practice bullet now says a concrete provider/model is required with no automatic model selection, instead of pointing at the router. Also updated a corpus string in the RAG snippet.
  • image-generation, index, quickstart/first-llm-call: mentions reworded or removed.
  • .mintlify/Assistant.md: the Smart Routing terminology entry is replaced with Provider Routing, so Ask AI stops describing a page that no longer exists.
  • README.md: feature bullet renamed to Provider Routing, stale nav-structure mentions removed.

Evals

  • Dropped q11 ("How does smart routing work..."), which pointed at the deleted page. CLAUDE.md updated from 22 to 21 questions.

Cosmetic

  • Both Next Steps groups that lost a card dropped from 4 to 3 under cols={2}, leaving an orphan on the second row. Each gets a fourth relevant card: Request Metadata on provider-routing, Provider Routing on the quickstart.

Verification

  • docs.json and tests/evals/dataset.json parse as valid JSON.
  • No smart-routing, @edenai, router_candidates or quality_cost references remain outside the docs.json redirect and the dated snapshots under v3/feedback/.
  • Every internal /v3/... link in the changed pages resolves to an existing file or a redirect.
  • Snippet tests were not run locally: no EDEN_AI_PRODUCTION_API_TOKEN in this environment. The only code touched is one string literal in the embeddings corpus, which no assertion depends on. Worth confirming CI is green.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Renamed “Smart Routing” references to “Provider Routing” across the documentation and homepage.
    • Clarified provider selection based on price, speed, and latency.
    • Added a redirect from the former Smart Routing URL.
    • Updated routing guidance to emphasize explicit provider/model values and request metadata.
    • Removed outdated Smart Routing content, examples, navigation links, and related limitations.

The `@edenai` router is no longer documented. Delete the Smart Routing
page and redirect /v3/llms/smart-routing to /v3/llms/provider-routing,
the closest surviving page.

Clean up everything that referenced it:

- request-metadata: drop the `auto` field from the sample response and
  the field table, the `auto` strategy row, the "When Eden AI chose the
  model" section, and the related use-case bullet.
- provider-routing: remove the Info block contrasting the two pages and
  the `routing.quality_cost` cross-link.
- embeddings: state that a concrete `provider/model` is required, with no
  automatic model selection, instead of pointing at the router.
- image-generation, index, quickstart: reword or drop the mentions.
- Assistant.md: replace the Smart Routing terminology entry with Provider
  Routing so Ask AI stops describing a page that no longer exists.
- evals: drop the smart-routing question (q11), leaving 21.

Both Next Steps card groups that lost a card get a fourth relevant one so
they still fill the two-column grid.
@mintlify

mintlify Bot commented Sep 1, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
edenai 🟢 Ready View Preview Sep 1, 2026, 10:18 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@coderabbitai

coderabbitai Bot commented Sep 1, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Essentials

Run ID: c53b627e-b1ba-4760-bf94-47496caee043

📥 Commits

Reviewing files that changed from the base of the PR and between c354310 and 98b987f.

📒 Files selected for processing (12)
  • .mintlify/Assistant.md
  • CLAUDE.md
  • README.md
  • docs.json
  • index.mdx
  • tests/evals/dataset.json
  • v3/llms/embeddings.mdx
  • v3/llms/image-generation.mdx
  • v3/llms/provider-routing.mdx
  • v3/llms/request-metadata.mdx
  • v3/llms/smart-routing.mdx
  • v3/quickstart/first-llm-call.mdx

Walkthrough

The documentation now uses “Provider Routing” terminology, redirects the former Smart Routing URL, removes automatic model-selection guidance, updates related examples, and removes the Smart Routing evaluation question.

Changes

Provider Routing documentation

Layer / File(s) Summary
Routing terminology and navigation
.mintlify/Assistant.md, README.md, docs.json, index.mdx, v3/llms/provider-routing.mdx, v3/quickstart/first-llm-call.mdx, v3/llms/smart-routing.mdx
Documentation now uses Provider Routing terminology. The former Smart Routing page was removed, and its URL redirects to the Provider Routing page. Navigation and next-step cards were updated.
Routing behavior guidance
v3/llms/embeddings.mdx, v3/llms/image-generation.mdx
Embedding guidance now requires explicit provider/model values. Image-generation guidance removes the deprecated router restriction while retaining the fallbacks limitation.
Request metadata reference
v3/llms/request-metadata.mdx
The auto metadata field, @edenai strategy, automatic model-selection section, and related usage note were removed.
Supporting documentation updates
CLAUDE.md, tests/evals/dataset.json
The documented evaluation dataset count changed from 22 to 21, and dataset entry q11 was removed.

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

Suggested reviewers: tristantelleb

Poem

A rabbit hops through docs so bright
Provider Routing names the night
Old Smart Routing links now turn
Metadata fields no longer churn
The guide grows clear from page to page

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch ahmednemdil/eng-135-pull-smart-routing-docs

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

@hMED22
hMED22 merged commit c064dda into main Sep 1, 2026
4 of 6 checks passed
@hMED22
hMED22 deleted the ahmednemdil/eng-135-pull-smart-routing-docs branch September 1, 2026 10:22
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