Skip to content

docs(evaluation): rewrite custom models guide to house style#752

Merged
khushalsonawat merged 4 commits into
docs/evaluation-revampfrom
docs/eval-guide-custom-models
Jul 16, 2026
Merged

docs(evaluation): rewrite custom models guide to house style#752
khushalsonawat merged 4 commits into
docs/evaluation-revampfrom
docs/eval-guide-custom-models

Conversation

@abhijaisrivastava15

Copy link
Copy Markdown
Contributor

Summary

Rewrites the "Use custom models" guide to match the house style used across the rest of the Evaluation batch:

  • Drops the <Steps> wizard layout and generic per-provider placeholder images, one H2/H3 per action instead
  • Fixes the nav path to the real one: Settings -> AI Providers -> Custom model tab -> Create custom model
  • Real drawer copy (Add Model, From model Provider / Configure Custom Model) instead of the old generic "model configuration (e.g. Settings or Models)" phrasing
  • 4 live screenshots: the Custom model list, the provider dropdown (OpenAI/Bedrock/SageMaker/Vertex AI/Azure), the OpenAI form, and the Configure Custom Model form
  • States clearly that saving IS the connectivity check (no separate test-connection step), matching what the UI actually does

Test plan

  • Astro dev renders the page with no MDX errors
  • All 4 images load and match current product UI
  • Links resolve: /docs/evaluation/guides/custom-evals, /docs/evaluation/guides/running-evaluations, /docs/evaluation/concepts/evaluator-models, /docs/evaluation/guides/cicd, /docs/evaluation

…l screenshots

Drops the Steps-wizard layout and generic placeholder images for the
same H2-per-action pattern the other eval guides use. Real nav path
(Settings -> AI Providers -> Custom model tab -> Create custom model),
real drawer copy, and live screenshots of both the From-Provider and
Configure-Custom-Model forms.
Base automatically changed from docs/evaluation-revamp to dev July 16, 2026 11:18
@khushalsonawat
khushalsonawat changed the base branch from dev to docs/evaluation-revamp July 16, 2026 11:56
Drop the banned About heading for a hero lead, cut the unverified
save-is-a-connectivity-check claim (create only validates and stores),
cut the When to use and Field reference repetition, rename the footer to
Keep exploring with four deliberate cards, and match provider names to
the UI. Mask every config block in the four screenshots with the house
masked-bar convention, keeping the edit, delete, and copy icons visible.

Signed-off-by: khushalsonawat <khushalsonawat@gmail.com>
@khushalsonawat
khushalsonawat merged commit 9810075 into docs/evaluation-revamp Jul 16, 2026
@khushalsonawat
khushalsonawat deleted the docs/eval-guide-custom-models branch July 16, 2026 16:33
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