docs(simulation): Personas concept - #747
Merged
Merged
Conversation
- Replaces plain GitHub icon with "Star on [icon] [⭐ count]" pill - Star count fetched from GitHub API with 10-min localStorage cache - Formatted as compact (e.g. 1.2k, 12k) — falls back to ★ if API fails - Matches the landing page header treatment for consistency Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Task-oriented guide for building a composite eval from the eval builder: switch to Composite, configure the child type and aggregation function, add child evals, set weights, save. Grounded in the live eval builder (EvalCreatePage.jsx, CompositeDetailPanel.jsx) and the create-composite endpoint.
… References section
…s/eval-ref-output-types Signed-off-by: khushalsonawat <khushalsonawat@gmail.com>
…move its nav entry Signed-off-by: khushalsonawat <khushalsonawat@gmail.com>
docs(evaluation): Output types & scoring (reference)
…s/eval-ref-sdk-api
…st wheel, fix reader flow) Signed-off-by: khushalsonawat <khushalsonawat@gmail.com>
docs(evaluation): SDK & API (reference)
…s/eval-builtin-polish
…methods in the intro Signed-off-by: khushalsonawat <khushalsonawat@gmail.com>
… span/trace/session level) Signed-off-by: khushalsonawat <khushalsonawat@gmail.com>
…usage docs(evaluation): Usage & analytics
Section title changed from features to guides
Walk the feedback flow on a dataset and in the eval playground, then review corrections on the Feedback tab. Adds annotated screenshots and wires the page into the Evaluation guides nav.
… screenshot - Reword the not-available Note so raw-number metrics don't read as a contradiction of Score evals (which are feedback-eligible) - Relabel the re-scoring screenshot's callout to 'Stores your correction, not a rule change', matching the page's criteria-unchanged point
docs(evaluation): add Collect feedback guide
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>
- Replace the gateway UI walkthrough and its 10 screenshots with a short text pointer to the Command Center gateway docs - Make the Protect SDK the core of the page: first check, per-language rule tables, verdict handling, input+output guarding, and Protect Flash, all verified against the SDK source - Flag that the Python and TypeScript SDKs accept different metric names
docs(evaluation): rewrite custom models guide to house style
docs(evaluation): Set up guardrails (how-to)
Adding the remaining guides
Add live GitHub star counter to docs header
…nd fits sections Signed-off-by: khushalsonawat <khushalsonawat@gmail.com>
Signed-off-by: khushalsonawat <khushalsonawat@gmail.com>
docs(simulation): Overview (revamp)
docs(simulation): Understanding Simulation (concept)
…s/simulation-agent-definitions
…s/simulation-scenarios
…xits Replace the scrapped jigsaw with the shared system diagram (agent in conversation with the FAGI simulator, fed by scenario and persona tables), saved as standalone SVGs with a highlighted copy per concept page. Scenarios drops the four build sources (how-to, now owned by the Create scenarios guide) and keeps definition, rows, simulator prompt, global nodes, and reuse. Both pages gain exits to the run/create/explore guides. Signed-off-by: khushalsonawat <khushalsonawat@gmail.com>
docs(simulation): Scenarios (concept, absorbs global-nodes)
Ground the page in the product code and fix the reader-experience issues from the review passes: - drop version score/pass_rate/test_count (dormant model fields, no writer and no UI) and the Draft/Deprecated statuses (never set in the flow) - drop the websocket transport claim; websocket_url has no consumer in the run path - state the version lifecycle in order so "frozen" no longer contradicts editing the live configuration - weaken the rollback claim: activate() only flips status, it does not restore the definition's configuration - lead voice with the sufficient path (a phone number) before the native Vapi/Retell integrations - bullets for the definition contents and provider inputs, self-contained diagram caption, persona and SDK linked, versions and action exits wired Signed-off-by: khushalsonawat <khushalsonawat@gmail.com>
…ions docs(simulation): Agent Definitions & Versions (concept)
Ground the page in the product code and close the reader-experience gaps: - correct the simulator agent: it is not user-configurable, and the persona is the surface you shape it through - replace the bespoke Mermaid with the shared simulation model diagram, personas block highlighted - rewrite the worked example; the old one pinned fast speech, interrupting and price sensitivity onto an Indian accent - state how a persona reaches a run: scenarios pick personas at creation and carry their traits into the rows, so nothing is picked at launch - add the missing profession, languages and multilingual fields; background noise is background sound - "user" is a reserved term, so the simulated party is the customer - rename the Persona settings reference to Built-in personas, matching how Evaluation names its built-ins, and wire the reference and guide links Signed-off-by: khushalsonawat <khushalsonawat@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stacked PR 2 of 4 (base:
docs/sim-replay, so it carries Replay too; review just the Personas file).The Personas concept (rewrite): what a persona is, the full customization surface (basic info, behaviour, voice traits, chat traits, custom properties, instructions), built-in vs custom, the simulator agent.
Pending links
concepts/agent-definitions) is Abhijai's parallel page (theagent-definitiontoagent-definitionsrename). Links to it resolve once that merges.