diff --git a/docs/administration/advanced-setup.mdx b/docs/administration/advanced-setup.mdx new file mode 100644 index 000000000..e49a0e709 --- /dev/null +++ b/docs/administration/advanced-setup.mdx @@ -0,0 +1,5 @@ +--- +title: "Advanced Setup" +description: "Advanced Arc configuration" +--- + diff --git a/docs/administration/bring-your-own-key.mdx b/docs/administration/bring-your-own-key.mdx new file mode 100644 index 000000000..1893b61f3 --- /dev/null +++ b/docs/administration/bring-your-own-key.mdx @@ -0,0 +1,5 @@ +--- +title: "Bring Your Own Key" +description: "Using your own API keys with Arc" +--- + diff --git a/docs/administration/costs.mdx b/docs/administration/costs.mdx new file mode 100644 index 000000000..114a0e742 --- /dev/null +++ b/docs/administration/costs.mdx @@ -0,0 +1,5 @@ +--- +title: "Costs" +description: "Understanding and managing costs" +--- + diff --git a/docs/administration/monitoring.mdx b/docs/administration/monitoring.mdx new file mode 100644 index 000000000..c3ca803a4 --- /dev/null +++ b/docs/administration/monitoring.mdx @@ -0,0 +1,5 @@ +--- +title: "Monitoring" +description: "Monitoring Arc in production" +--- + diff --git a/docs/administration/sandboxing.mdx b/docs/administration/sandboxing.mdx new file mode 100644 index 000000000..aa351b5bb --- /dev/null +++ b/docs/administration/sandboxing.mdx @@ -0,0 +1,5 @@ +--- +title: "Sandboxing" +description: "Sandboxing workflow execution" +--- + diff --git a/docs/administration/security.mdx b/docs/administration/security.mdx new file mode 100644 index 000000000..a6985a994 --- /dev/null +++ b/docs/administration/security.mdx @@ -0,0 +1,5 @@ +--- +title: "Security" +description: "Security model and best practices" +--- + diff --git a/docs/administration/usage.mdx b/docs/administration/usage.mdx new file mode 100644 index 000000000..3dd37d587 --- /dev/null +++ b/docs/administration/usage.mdx @@ -0,0 +1,5 @@ +--- +title: "Usage" +description: "Tracking and managing usage" +--- + diff --git a/docs/agents/hooks.mdx b/docs/agents/hooks.mdx new file mode 100644 index 000000000..55a531959 --- /dev/null +++ b/docs/agents/hooks.mdx @@ -0,0 +1,5 @@ +--- +title: "Hooks" +description: "Agent lifecycle hooks" +--- + diff --git a/docs/agents/mcp.mdx b/docs/agents/mcp.mdx new file mode 100644 index 000000000..2d3e48e85 --- /dev/null +++ b/docs/agents/mcp.mdx @@ -0,0 +1,5 @@ +--- +title: "MCP" +description: "Model Context Protocol integration" +--- + diff --git a/docs/agents/outputs.mdx b/docs/agents/outputs.mdx new file mode 100644 index 000000000..7a879195f --- /dev/null +++ b/docs/agents/outputs.mdx @@ -0,0 +1,5 @@ +--- +title: "Outputs" +description: "Agent output handling" +--- + diff --git a/docs/agents/permissions.mdx b/docs/agents/permissions.mdx new file mode 100644 index 000000000..ed8d64433 --- /dev/null +++ b/docs/agents/permissions.mdx @@ -0,0 +1,5 @@ +--- +title: "Permissions" +description: "Agent permissions: read and read-write access" +--- + diff --git a/docs/agents/prompts.mdx b/docs/agents/prompts.mdx new file mode 100644 index 000000000..5ff9a53cb --- /dev/null +++ b/docs/agents/prompts.mdx @@ -0,0 +1,5 @@ +--- +title: "Prompts" +description: "Internal and external agent prompts" +--- + diff --git a/docs/agents/skills.mdx b/docs/agents/skills.mdx new file mode 100644 index 000000000..72379f6ba --- /dev/null +++ b/docs/agents/skills.mdx @@ -0,0 +1,5 @@ +--- +title: "Skills" +description: "Defining agent skills" +--- + diff --git a/docs/agents/subagents.mdx b/docs/agents/subagents.mdx new file mode 100644 index 000000000..4feebaf1a --- /dev/null +++ b/docs/agents/subagents.mdx @@ -0,0 +1,5 @@ +--- +title: "Subagents" +description: "Spawning and managing subagents" +--- + diff --git a/docs/agents/tools.mdx b/docs/agents/tools.mdx new file mode 100644 index 000000000..17f96f0fe --- /dev/null +++ b/docs/agents/tools.mdx @@ -0,0 +1,5 @@ +--- +title: "Tools" +description: "Agent tools and capabilities" +--- + diff --git a/docs/changelog.mdx b/docs/changelog.mdx new file mode 100644 index 000000000..714a3e98b --- /dev/null +++ b/docs/changelog.mdx @@ -0,0 +1,5 @@ +--- +title: "Changelog" +description: "Latest updates and changes to Arc" +--- + diff --git a/docs/core-concepts/agents.mdx b/docs/core-concepts/agents.mdx new file mode 100644 index 000000000..71d34b812 --- /dev/null +++ b/docs/core-concepts/agents.mdx @@ -0,0 +1,5 @@ +--- +title: "Agents" +description: "Core agent concepts in Arc" +--- + diff --git a/docs/core-concepts/how-arc-works.mdx b/docs/core-concepts/how-arc-works.mdx new file mode 100644 index 000000000..91333750c --- /dev/null +++ b/docs/core-concepts/how-arc-works.mdx @@ -0,0 +1,5 @@ +--- +title: "How Arc Works" +description: "Understand the Arc architecture and execution model" +--- + diff --git a/docs/core-concepts/workflows.mdx b/docs/core-concepts/workflows.mdx new file mode 100644 index 000000000..39de53496 --- /dev/null +++ b/docs/core-concepts/workflows.mdx @@ -0,0 +1,5 @@ +--- +title: "Workflows" +description: "Core workflow concepts in Arc" +--- + diff --git a/docs/deployment/deploying-to-aws.mdx b/docs/deployment/deploying-to-aws.mdx new file mode 100644 index 000000000..de8b2b3ad --- /dev/null +++ b/docs/deployment/deploying-to-aws.mdx @@ -0,0 +1,5 @@ +--- +title: "Deploying to AWS" +description: "Deploy Arc to AWS" +--- + diff --git a/docs/deployment/environments.mdx b/docs/deployment/environments.mdx new file mode 100644 index 000000000..65e0c7b87 --- /dev/null +++ b/docs/deployment/environments.mdx @@ -0,0 +1,5 @@ +--- +title: "Environments" +description: "Managing deployment environments" +--- + diff --git a/docs/deployment/overview.mdx b/docs/deployment/overview.mdx new file mode 100644 index 000000000..5a732c948 --- /dev/null +++ b/docs/deployment/overview.mdx @@ -0,0 +1,5 @@ +--- +title: "Overview" +description: "Deployment overview" +--- + diff --git a/docs/docs.json b/docs/docs.json index 2d5f9da90..0bfa57747 100644 --- a/docs/docs.json +++ b/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": { diff --git a/docs/examples/implement-feature.mdx b/docs/examples/implement-feature.mdx new file mode 100644 index 000000000..911a5320a --- /dev/null +++ b/docs/examples/implement-feature.mdx @@ -0,0 +1,5 @@ +--- +title: "Implement Feature" +description: "Example workflow for implementing a feature" +--- + diff --git a/docs/examples/investigate-alert.mdx b/docs/examples/investigate-alert.mdx new file mode 100644 index 000000000..284901243 --- /dev/null +++ b/docs/examples/investigate-alert.mdx @@ -0,0 +1,5 @@ +--- +title: "Investigate Alert" +description: "Example workflow for investigating alerts" +--- + diff --git a/docs/examples/nlspec-convergence.mdx b/docs/examples/nlspec-convergence.mdx new file mode 100644 index 000000000..36a8e3b98 --- /dev/null +++ b/docs/examples/nlspec-convergence.mdx @@ -0,0 +1,5 @@ +--- +title: "NLSpec Convergence" +description: "Example workflow for NLSpec convergence" +--- + diff --git a/docs/examples/semantic-port.mdx b/docs/examples/semantic-port.mdx new file mode 100644 index 000000000..492e918fd --- /dev/null +++ b/docs/examples/semantic-port.mdx @@ -0,0 +1,5 @@ +--- +title: "Semantic Port" +description: "Example workflow for semantic porting" +--- + diff --git a/docs/execution/checkpoints.mdx b/docs/execution/checkpoints.mdx new file mode 100644 index 000000000..e8a759090 --- /dev/null +++ b/docs/execution/checkpoints.mdx @@ -0,0 +1,7 @@ +--- +title: "Checkpoints" +description: "Saving and resuming workflow state" +--- + +## Resume + diff --git a/docs/execution/compounding.mdx b/docs/execution/compounding.mdx new file mode 100644 index 000000000..1d91c4eac --- /dev/null +++ b/docs/execution/compounding.mdx @@ -0,0 +1,5 @@ +--- +title: "Compounding" +description: "Compounding workflows for iterative improvement" +--- + diff --git a/docs/execution/context.mdx b/docs/execution/context.mdx new file mode 100644 index 000000000..4f0d09a94 --- /dev/null +++ b/docs/execution/context.mdx @@ -0,0 +1,5 @@ +--- +title: "Context" +description: "Providing context to workflow runs" +--- + diff --git a/docs/execution/environments.mdx b/docs/execution/environments.mdx new file mode 100644 index 000000000..8fe141354 --- /dev/null +++ b/docs/execution/environments.mdx @@ -0,0 +1,5 @@ +--- +title: "Environments" +description: "Execution environments for workflow runs" +--- + diff --git a/docs/execution/failures.mdx b/docs/execution/failures.mdx new file mode 100644 index 000000000..26daec02e --- /dev/null +++ b/docs/execution/failures.mdx @@ -0,0 +1,9 @@ +--- +title: "Failures" +description: "Handling failures during workflow execution" +--- + +## Model Failures + +## Loop Detection + diff --git a/docs/execution/insights.mdx b/docs/execution/insights.mdx new file mode 100644 index 000000000..e6c335409 --- /dev/null +++ b/docs/execution/insights.mdx @@ -0,0 +1,9 @@ +--- +title: "Insights" +description: "Observability and analysis of workflow runs" +--- + +## Events Log + +## Summaries + diff --git a/docs/execution/interviews.mdx b/docs/execution/interviews.mdx new file mode 100644 index 000000000..a52703fc1 --- /dev/null +++ b/docs/execution/interviews.mdx @@ -0,0 +1,9 @@ +--- +title: "Interviews" +description: "Collecting information from users during workflow execution" +--- + +## Question Types + +## Channels + diff --git a/docs/execution/run-configuration.mdx b/docs/execution/run-configuration.mdx new file mode 100644 index 000000000..3ee21ab30 --- /dev/null +++ b/docs/execution/run-configuration.mdx @@ -0,0 +1,5 @@ +--- +title: "Run Configuration" +description: "Configuring workflow runs" +--- + diff --git a/docs/getting-started/overview.mdx b/docs/getting-started/overview.mdx new file mode 100644 index 000000000..a01bb9913 --- /dev/null +++ b/docs/getting-started/overview.mdx @@ -0,0 +1,5 @@ +--- +title: "Overview" +description: "Why Arc?" +--- + diff --git a/docs/getting-started/quick-start.mdx b/docs/getting-started/quick-start.mdx new file mode 100644 index 000000000..b2f6a8911 --- /dev/null +++ b/docs/getting-started/quick-start.mdx @@ -0,0 +1,5 @@ +--- +title: "Quick Start" +description: "Get up and running with Arc" +--- + diff --git a/docs/getting-started/workflows.mdx b/docs/getting-started/workflows.mdx new file mode 100644 index 000000000..474cc9e58 --- /dev/null +++ b/docs/getting-started/workflows.mdx @@ -0,0 +1,5 @@ +--- +title: "Workflows" +description: "Introduction to Arc workflows" +--- + diff --git a/docs/reference/architecture.mdx b/docs/reference/architecture.mdx new file mode 100644 index 000000000..a736e13a4 --- /dev/null +++ b/docs/reference/architecture.mdx @@ -0,0 +1,5 @@ +--- +title: "Architecture" +description: "Arc system architecture" +--- + diff --git a/docs/reference/cli.mdx b/docs/reference/cli.mdx new file mode 100644 index 000000000..773f961df --- /dev/null +++ b/docs/reference/cli.mdx @@ -0,0 +1,5 @@ +--- +title: "CLI Reference" +description: "Arc command-line interface reference" +--- + diff --git a/docs/reference/dot-language.mdx b/docs/reference/dot-language.mdx new file mode 100644 index 000000000..9851e88b5 --- /dev/null +++ b/docs/reference/dot-language.mdx @@ -0,0 +1,5 @@ +--- +title: "DOT Language" +description: "Arc's DOT language reference" +--- + diff --git a/docs/reference/extensions.mdx b/docs/reference/extensions.mdx new file mode 100644 index 000000000..a55442915 --- /dev/null +++ b/docs/reference/extensions.mdx @@ -0,0 +1,5 @@ +--- +title: "Extensions" +description: "Arc extensions reference" +--- + diff --git a/docs/reference/hooks.mdx b/docs/reference/hooks.mdx new file mode 100644 index 000000000..d779fadc2 --- /dev/null +++ b/docs/reference/hooks.mdx @@ -0,0 +1,5 @@ +--- +title: "Hooks" +description: "Hooks reference" +--- + diff --git a/docs/reference/llms.mdx b/docs/reference/llms.mdx new file mode 100644 index 000000000..2648dd18a --- /dev/null +++ b/docs/reference/llms.mdx @@ -0,0 +1,11 @@ +--- +title: "LLMs" +description: "LLM integration reference" +--- + +## Models + +## Unified LLM + +### Middleware + diff --git a/docs/workflows/best-practices.mdx b/docs/workflows/best-practices.mdx new file mode 100644 index 000000000..6c816c828 --- /dev/null +++ b/docs/workflows/best-practices.mdx @@ -0,0 +1,5 @@ +--- +title: "Best Practices" +description: "Best practices for designing workflows" +--- + diff --git a/docs/workflows/human-in-the-loop.mdx b/docs/workflows/human-in-the-loop.mdx new file mode 100644 index 000000000..2d8c7fded --- /dev/null +++ b/docs/workflows/human-in-the-loop.mdx @@ -0,0 +1,5 @@ +--- +title: "Human-in-the-Loop" +description: "Adding human review and intervention to workflows" +--- + diff --git a/docs/workflows/ingestion.mdx b/docs/workflows/ingestion.mdx new file mode 100644 index 000000000..3c9769396 --- /dev/null +++ b/docs/workflows/ingestion.mdx @@ -0,0 +1,5 @@ +--- +title: "Ingestion" +description: "How Arc ingests workflow definitions" +--- + diff --git a/docs/workflows/stages-and-nodes.mdx b/docs/workflows/stages-and-nodes.mdx new file mode 100644 index 000000000..524140fc3 --- /dev/null +++ b/docs/workflows/stages-and-nodes.mdx @@ -0,0 +1,5 @@ +--- +title: "Stages & Nodes" +description: "Defining stages and nodes in workflows" +--- + diff --git a/docs/workflows/stylesheets.mdx b/docs/workflows/stylesheets.mdx new file mode 100644 index 000000000..9a6b62009 --- /dev/null +++ b/docs/workflows/stylesheets.mdx @@ -0,0 +1,5 @@ +--- +title: "Stylesheets" +description: "Styling workflow definitions" +--- + diff --git a/docs/workflows/transitions.mdx b/docs/workflows/transitions.mdx new file mode 100644 index 000000000..48732c03a --- /dev/null +++ b/docs/workflows/transitions.mdx @@ -0,0 +1,5 @@ +--- +title: "Transitions" +description: "Defining transitions between stages" +--- + diff --git a/docs/workflows/variables.mdx b/docs/workflows/variables.mdx new file mode 100644 index 000000000..f11e67c41 --- /dev/null +++ b/docs/workflows/variables.mdx @@ -0,0 +1,5 @@ +--- +title: "Variables" +description: "Using variables in workflows" +--- +