mirror of
https://github.com/fabro-sh/fabro.git
synced 2026-09-12 23:02:41 +00:00
Scaffold Mintlify docs site with full navigation structure
Replace boilerplate Mintlify starter with Arc docs outline: - Switch to almond theme (sidebar search, card-based layout) - Top nav: Documentation, Guides, API Reference, Changelog - Documentation sidebar: Getting Started, Core Concepts, Defining Workflows, Executing Workflows, Agents, Administration, Deployment, Reference - Guides tab with example workflows - Get Started button in navbar - 48 MDX stub pages across 9 directories Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
864cb5d853
commit
d450695a20
51 changed files with 380 additions and 52 deletions
5
docs/administration/advanced-setup.mdx
Normal file
5
docs/administration/advanced-setup.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Advanced Setup"
|
||||
description: "Advanced Arc configuration"
|
||||
---
|
||||
|
||||
5
docs/administration/bring-your-own-key.mdx
Normal file
5
docs/administration/bring-your-own-key.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Bring Your Own Key"
|
||||
description: "Using your own API keys with Arc"
|
||||
---
|
||||
|
||||
5
docs/administration/costs.mdx
Normal file
5
docs/administration/costs.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Costs"
|
||||
description: "Understanding and managing costs"
|
||||
---
|
||||
|
||||
5
docs/administration/monitoring.mdx
Normal file
5
docs/administration/monitoring.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Monitoring"
|
||||
description: "Monitoring Arc in production"
|
||||
---
|
||||
|
||||
5
docs/administration/sandboxing.mdx
Normal file
5
docs/administration/sandboxing.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Sandboxing"
|
||||
description: "Sandboxing workflow execution"
|
||||
---
|
||||
|
||||
5
docs/administration/security.mdx
Normal file
5
docs/administration/security.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Security"
|
||||
description: "Security model and best practices"
|
||||
---
|
||||
|
||||
5
docs/administration/usage.mdx
Normal file
5
docs/administration/usage.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Usage"
|
||||
description: "Tracking and managing usage"
|
||||
---
|
||||
|
||||
5
docs/agents/hooks.mdx
Normal file
5
docs/agents/hooks.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Hooks"
|
||||
description: "Agent lifecycle hooks"
|
||||
---
|
||||
|
||||
5
docs/agents/mcp.mdx
Normal file
5
docs/agents/mcp.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "MCP"
|
||||
description: "Model Context Protocol integration"
|
||||
---
|
||||
|
||||
5
docs/agents/outputs.mdx
Normal file
5
docs/agents/outputs.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Outputs"
|
||||
description: "Agent output handling"
|
||||
---
|
||||
|
||||
5
docs/agents/permissions.mdx
Normal file
5
docs/agents/permissions.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Permissions"
|
||||
description: "Agent permissions: read and read-write access"
|
||||
---
|
||||
|
||||
5
docs/agents/prompts.mdx
Normal file
5
docs/agents/prompts.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Prompts"
|
||||
description: "Internal and external agent prompts"
|
||||
---
|
||||
|
||||
5
docs/agents/skills.mdx
Normal file
5
docs/agents/skills.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Skills"
|
||||
description: "Defining agent skills"
|
||||
---
|
||||
|
||||
5
docs/agents/subagents.mdx
Normal file
5
docs/agents/subagents.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Subagents"
|
||||
description: "Spawning and managing subagents"
|
||||
---
|
||||
|
||||
5
docs/agents/tools.mdx
Normal file
5
docs/agents/tools.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Tools"
|
||||
description: "Agent tools and capabilities"
|
||||
---
|
||||
|
||||
5
docs/changelog.mdx
Normal file
5
docs/changelog.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Changelog"
|
||||
description: "Latest updates and changes to Arc"
|
||||
---
|
||||
|
||||
5
docs/core-concepts/agents.mdx
Normal file
5
docs/core-concepts/agents.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Agents"
|
||||
description: "Core agent concepts in Arc"
|
||||
---
|
||||
|
||||
5
docs/core-concepts/how-arc-works.mdx
Normal file
5
docs/core-concepts/how-arc-works.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "How Arc Works"
|
||||
description: "Understand the Arc architecture and execution model"
|
||||
---
|
||||
|
||||
5
docs/core-concepts/workflows.mdx
Normal file
5
docs/core-concepts/workflows.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Workflows"
|
||||
description: "Core workflow concepts in Arc"
|
||||
---
|
||||
|
||||
5
docs/deployment/deploying-to-aws.mdx
Normal file
5
docs/deployment/deploying-to-aws.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Deploying to AWS"
|
||||
description: "Deploy Arc to AWS"
|
||||
---
|
||||
|
||||
5
docs/deployment/environments.mdx
Normal file
5
docs/deployment/environments.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Environments"
|
||||
description: "Managing deployment environments"
|
||||
---
|
||||
|
||||
5
docs/deployment/overview.mdx
Normal file
5
docs/deployment/overview.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Overview"
|
||||
description: "Deployment overview"
|
||||
---
|
||||
|
||||
162
docs/docs.json
162
docs/docs.json
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"$schema": "https://mintlify.com/docs.json",
|
||||
"theme": "mint",
|
||||
"theme": "almond",
|
||||
"name": "Arc",
|
||||
"colors": {
|
||||
"primary": "#16A34A",
|
||||
|
|
@ -10,39 +10,106 @@
|
|||
"favicon": "/favicon.svg",
|
||||
"navigation": {
|
||||
"tabs": [
|
||||
{
|
||||
"tab": "Documentation",
|
||||
"groups": [
|
||||
{
|
||||
"group": "Getting Started",
|
||||
"pages": [
|
||||
"getting-started/overview",
|
||||
"getting-started/quick-start",
|
||||
"getting-started/workflows"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Core Concepts",
|
||||
"pages": [
|
||||
"core-concepts/how-arc-works",
|
||||
"core-concepts/workflows",
|
||||
"core-concepts/agents"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Defining Workflows",
|
||||
"pages": [
|
||||
"workflows/ingestion",
|
||||
"workflows/stages-and-nodes",
|
||||
"workflows/transitions",
|
||||
"workflows/variables",
|
||||
"workflows/human-in-the-loop",
|
||||
"workflows/stylesheets",
|
||||
"workflows/best-practices"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Executing Workflows",
|
||||
"pages": [
|
||||
"execution/run-configuration",
|
||||
"execution/environments",
|
||||
"execution/context",
|
||||
"execution/checkpoints",
|
||||
"execution/interviews",
|
||||
"execution/failures",
|
||||
"execution/insights",
|
||||
"execution/compounding"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Agents",
|
||||
"pages": [
|
||||
"agents/prompts",
|
||||
"agents/skills",
|
||||
"agents/tools",
|
||||
"agents/mcp",
|
||||
"agents/hooks",
|
||||
"agents/subagents",
|
||||
"agents/permissions",
|
||||
"agents/outputs"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Administration",
|
||||
"pages": [
|
||||
"administration/advanced-setup",
|
||||
"administration/bring-your-own-key",
|
||||
"administration/sandboxing",
|
||||
"administration/security",
|
||||
"administration/usage",
|
||||
"administration/monitoring",
|
||||
"administration/costs"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Deployment",
|
||||
"pages": [
|
||||
"deployment/overview",
|
||||
"deployment/deploying-to-aws",
|
||||
"deployment/environments"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Reference",
|
||||
"pages": [
|
||||
"reference/dot-language",
|
||||
"reference/cli",
|
||||
"reference/hooks",
|
||||
"reference/extensions",
|
||||
"reference/llms",
|
||||
"reference/architecture"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"tab": "Guides",
|
||||
"groups": [
|
||||
{
|
||||
"group": "Getting started",
|
||||
"group": "Example Workflows",
|
||||
"pages": [
|
||||
"index",
|
||||
"quickstart",
|
||||
"development"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Customization",
|
||||
"pages": [
|
||||
"essentials/settings",
|
||||
"essentials/navigation"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Writing content",
|
||||
"pages": [
|
||||
"essentials/markdown",
|
||||
"essentials/code",
|
||||
"essentials/images",
|
||||
"essentials/reusable-snippets"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "AI tools",
|
||||
"pages": [
|
||||
"ai-tools/cursor",
|
||||
"ai-tools/claude-code",
|
||||
"ai-tools/windsurf"
|
||||
"examples/implement-feature",
|
||||
"examples/semantic-port",
|
||||
"examples/nlspec-convergence",
|
||||
"examples/investigate-alert"
|
||||
]
|
||||
}
|
||||
]
|
||||
|
|
@ -158,38 +225,29 @@
|
|||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"tab": "Changelog",
|
||||
"groups": [
|
||||
{
|
||||
"group": "Changelog",
|
||||
"pages": [
|
||||
"changelog"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"global": {
|
||||
"anchors": [
|
||||
{
|
||||
"anchor": "Documentation",
|
||||
"href": "https://mintlify.com/docs",
|
||||
"icon": "book-open-cover"
|
||||
},
|
||||
{
|
||||
"anchor": "Blog",
|
||||
"href": "https://mintlify.com/blog",
|
||||
"icon": "newspaper"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"logo": {
|
||||
"light": "/logo/light.svg",
|
||||
"dark": "/logo/dark.svg"
|
||||
},
|
||||
"navbar": {
|
||||
"links": [
|
||||
{
|
||||
"label": "Support",
|
||||
"href": "mailto:hi@mintlify.com"
|
||||
}
|
||||
],
|
||||
"primary": {
|
||||
"type": "button",
|
||||
"label": "Dashboard",
|
||||
"href": "https://dashboard.mintlify.com"
|
||||
"label": "Get Started",
|
||||
"href": "/getting-started/quick-start"
|
||||
}
|
||||
},
|
||||
"contextual": {
|
||||
|
|
|
|||
5
docs/examples/implement-feature.mdx
Normal file
5
docs/examples/implement-feature.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Implement Feature"
|
||||
description: "Example workflow for implementing a feature"
|
||||
---
|
||||
|
||||
5
docs/examples/investigate-alert.mdx
Normal file
5
docs/examples/investigate-alert.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Investigate Alert"
|
||||
description: "Example workflow for investigating alerts"
|
||||
---
|
||||
|
||||
5
docs/examples/nlspec-convergence.mdx
Normal file
5
docs/examples/nlspec-convergence.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "NLSpec Convergence"
|
||||
description: "Example workflow for NLSpec convergence"
|
||||
---
|
||||
|
||||
5
docs/examples/semantic-port.mdx
Normal file
5
docs/examples/semantic-port.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Semantic Port"
|
||||
description: "Example workflow for semantic porting"
|
||||
---
|
||||
|
||||
7
docs/execution/checkpoints.mdx
Normal file
7
docs/execution/checkpoints.mdx
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: "Checkpoints"
|
||||
description: "Saving and resuming workflow state"
|
||||
---
|
||||
|
||||
## Resume
|
||||
|
||||
5
docs/execution/compounding.mdx
Normal file
5
docs/execution/compounding.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Compounding"
|
||||
description: "Compounding workflows for iterative improvement"
|
||||
---
|
||||
|
||||
5
docs/execution/context.mdx
Normal file
5
docs/execution/context.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Context"
|
||||
description: "Providing context to workflow runs"
|
||||
---
|
||||
|
||||
5
docs/execution/environments.mdx
Normal file
5
docs/execution/environments.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Environments"
|
||||
description: "Execution environments for workflow runs"
|
||||
---
|
||||
|
||||
9
docs/execution/failures.mdx
Normal file
9
docs/execution/failures.mdx
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: "Failures"
|
||||
description: "Handling failures during workflow execution"
|
||||
---
|
||||
|
||||
## Model Failures
|
||||
|
||||
## Loop Detection
|
||||
|
||||
9
docs/execution/insights.mdx
Normal file
9
docs/execution/insights.mdx
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: "Insights"
|
||||
description: "Observability and analysis of workflow runs"
|
||||
---
|
||||
|
||||
## Events Log
|
||||
|
||||
## Summaries
|
||||
|
||||
9
docs/execution/interviews.mdx
Normal file
9
docs/execution/interviews.mdx
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: "Interviews"
|
||||
description: "Collecting information from users during workflow execution"
|
||||
---
|
||||
|
||||
## Question Types
|
||||
|
||||
## Channels
|
||||
|
||||
5
docs/execution/run-configuration.mdx
Normal file
5
docs/execution/run-configuration.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Run Configuration"
|
||||
description: "Configuring workflow runs"
|
||||
---
|
||||
|
||||
5
docs/getting-started/overview.mdx
Normal file
5
docs/getting-started/overview.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Overview"
|
||||
description: "Why Arc?"
|
||||
---
|
||||
|
||||
5
docs/getting-started/quick-start.mdx
Normal file
5
docs/getting-started/quick-start.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Quick Start"
|
||||
description: "Get up and running with Arc"
|
||||
---
|
||||
|
||||
5
docs/getting-started/workflows.mdx
Normal file
5
docs/getting-started/workflows.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Workflows"
|
||||
description: "Introduction to Arc workflows"
|
||||
---
|
||||
|
||||
5
docs/reference/architecture.mdx
Normal file
5
docs/reference/architecture.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Architecture"
|
||||
description: "Arc system architecture"
|
||||
---
|
||||
|
||||
5
docs/reference/cli.mdx
Normal file
5
docs/reference/cli.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "CLI Reference"
|
||||
description: "Arc command-line interface reference"
|
||||
---
|
||||
|
||||
5
docs/reference/dot-language.mdx
Normal file
5
docs/reference/dot-language.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "DOT Language"
|
||||
description: "Arc's DOT language reference"
|
||||
---
|
||||
|
||||
5
docs/reference/extensions.mdx
Normal file
5
docs/reference/extensions.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Extensions"
|
||||
description: "Arc extensions reference"
|
||||
---
|
||||
|
||||
5
docs/reference/hooks.mdx
Normal file
5
docs/reference/hooks.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Hooks"
|
||||
description: "Hooks reference"
|
||||
---
|
||||
|
||||
11
docs/reference/llms.mdx
Normal file
11
docs/reference/llms.mdx
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
---
|
||||
title: "LLMs"
|
||||
description: "LLM integration reference"
|
||||
---
|
||||
|
||||
## Models
|
||||
|
||||
## Unified LLM
|
||||
|
||||
### Middleware
|
||||
|
||||
5
docs/workflows/best-practices.mdx
Normal file
5
docs/workflows/best-practices.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Best Practices"
|
||||
description: "Best practices for designing workflows"
|
||||
---
|
||||
|
||||
5
docs/workflows/human-in-the-loop.mdx
Normal file
5
docs/workflows/human-in-the-loop.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Human-in-the-Loop"
|
||||
description: "Adding human review and intervention to workflows"
|
||||
---
|
||||
|
||||
5
docs/workflows/ingestion.mdx
Normal file
5
docs/workflows/ingestion.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Ingestion"
|
||||
description: "How Arc ingests workflow definitions"
|
||||
---
|
||||
|
||||
5
docs/workflows/stages-and-nodes.mdx
Normal file
5
docs/workflows/stages-and-nodes.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Stages & Nodes"
|
||||
description: "Defining stages and nodes in workflows"
|
||||
---
|
||||
|
||||
5
docs/workflows/stylesheets.mdx
Normal file
5
docs/workflows/stylesheets.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Stylesheets"
|
||||
description: "Styling workflow definitions"
|
||||
---
|
||||
|
||||
5
docs/workflows/transitions.mdx
Normal file
5
docs/workflows/transitions.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Transitions"
|
||||
description: "Defining transitions between stages"
|
||||
---
|
||||
|
||||
5
docs/workflows/variables.mdx
Normal file
5
docs/workflows/variables.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Variables"
|
||||
description: "Using variables in workflows"
|
||||
---
|
||||
|
||||
Loading…
Add table
Reference in a new issue