docs(arkdock): Arkdock documentation#1
Conversation
Adds complete Mintlify docs for Arkdock covering: overview with workflow diagram, quickstart, agents, scenarios, simulations, evaluations, annotations, knowledge, metrics, and settings. Updates docs.json with Arkdock branding, navigation, navbar, footer, and contextual AI options.
Includes agent-ready components, ai-tools setup guides, api-reference template, and essentials reference pages from the Mintlify starter kit.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
kmchen-arklex
requested review from
KathyLiu20,
itsarbit,
jackytungArticulateAI,
salianahshal2,
shehan360 and
xinyang-articulate
kmchen-arklex
changed the title
|
- Remove LLM judge provider/model selector from evaluations, quickstart, and overview — the new evaluation form only has name, simulation, and metrics - Remove "Also run an evaluation" from simulation docs — that UI is commented out pending backend support - Fix agent deletion: backend rejects deletion when simulations/evaluations still reference the agent; update card fields to show simulation + evaluation counts instead of average failure rate - Fix knowledge website section: document Add Domain (multi-page crawl) and Add Link (single URL/YouTube) buttons instead of the removed Add Website - Fix settings profile fields: photo, name, company, read-only email and role; no password management; rename Admin role to Owner throughout - Fix annotation save behavior: explicit Save Annotation button, not auto-save - Fix resolution rules: strict majority vote with admin override for ties, not averaging or spread thresholds - Remove Completion Rate column from simulation table (not in actual UI) - Expand custom metric form docs to include type, scope, system prompt, user prompt template, and type-specific config; remove Color as an API field - Add picker-first flow description to scenario creation; gate Conversation History mode behind feature flag note - Remove all Mintlify starter content (index.mdx, agent-ready/, essentials/, ai-tools/, api-reference/, development.mdx); replace with Arkdock content
|
Hi @xinyang-articulate , all comments are fixed. Thanks~~ |
Consider opening with the pain point, e.g. "You've built an AI agent. How do you know it actually works for real users before you ship it?", then introducing Arkdock as the answer.
|
- Add pain-point hook to Overview opening paragraph - Add common use cases section to Overview (regression testing, A/B prompts, baseline establishment) - Simplify Mermaid flowchart node labels for a cleaner display; mark Knowledge Base as optional with a dashed edge - Add human-annotation calibration loop diagram to the "Human-in-the-loop calibration" section in Overview - Add linear 5-step user-journey diagram to the top of Quickstart - Add hex color swatches to status tables in agents.mdx and simulations.mdx
- evaluations.mdx: fix FAQ, annotations input range, Final Score column, and Goal Completion cross-reference (0-1 rather than 1-5) - overview.mdx: fix custom metrics description - metrics.mdx: fix Goal Completion cross-reference, type-specific config example, and example rubric (remove Score 0, use Score 1 as lowest)
|
Add a contact & support page |
Moved the full Metric Alignment section (starting a run, phases, statuses, reviewing results, cancelling, history, and alignment-specific FAQ) out of metrics.mdx into a new metric-alignment.mdx page. Replaced the section in metrics.mdx with a short two-sentence link-out. Added an "Advanced" nav group in docs.json containing the new page.
- Updated quickstart.mdx - Updated overview.mdx - Created images/overview-diagram.png - Created images/calibration-loop.png - Created faq.mdx - Updated docs.json Mintlify-Source: dashboard-editor
- Updated quickstart.mdx Mintlify-Source: dashboard-editor
- Updated quickstart.mdx Mintlify-Source: dashboard-editor
New support.mdx covers email contact, what to include in a request, quick links to relevant docs pages, and billing/account guidance. Added a "Help" nav group in docs.json containing the new page.
Replaced the verbose multi-section layout with the same structure as docs.arklex.ai/v0.3.x/contact-email: a brief Get Help paragraph with an email link and a two-card Connect With Us section (GitHub, LinkedIn).
Removed the onboarding checklist note, nested sub-steps, roles table, duplicate step entries, billing step, and verbose prose. Rewrote as a single Steps block covering account creation through reviewing results, matching the lean reference style at docs.arklex.ai/v0.3.x/quickstart.
4 participants
Summary
docs.jsonwith Arkdock branding, navigation groups, navbar, footer socials, and contextual AI tool optionsPreview
https://arklex-06dfaf56-feat-arkdock-documentation.mintlify.app/overview
Test plan
mint devand verify all navigation links resolvedocs.jsonare correct for production