diff --git a/CHANGELOG.md b/CHANGELOG.md index 0cf791e12..7fec59fcd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -384,3 +384,7 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). - BDD test suite (Behave + Robot Framework). - Nox automation for lint, typecheck, tests, docs, benchmarks. - MkDocs-powered documentation with CleverAgents branding. + +### Added +- docs: Add quick start guide (docs/quickstart.md) and mkdocs navigation entry (PR #9245) + diff --git a/docs/quickstart.md b/docs/quickstart.md new file mode 100644 index 000000000..ffeb19988 --- /dev/null +++ b/docs/quickstart.md @@ -0,0 +1,44 @@ +# Quick Start Guide + +This quick start guide will walk you through creating a new project, registering a resource, running a plan, and applying changes with CleverAgents. + +## Prerequisites + +- Python 3.11+ and virtualenv +- Git +- A working CleverAgents installation (see development/testing.md for details) + +## Install (local development) + +```bash +python -m venv .venv +source .venv/bin/activate +pip install -e .[dev] +``` + +## Create a new project + +```bash +# Create a new directory for your project +mkdir my-project && cd my-project +# Initialize a CleverAgents project (example command) +cleveragents init --name my-project +``` + +## Register a resource + +Create a resource file under `resources/` (example YAML) and register it with the CLI or API. + +## Plan and apply + +```bash +# Generate a plan +cleveragents plan --project my-project +# Review the plan, then apply +cleveragents apply --project my-project +``` + +## Troubleshooting + +If you encounter issues running the examples above, consult `docs/development/testing.md` and the project README for local development tips. + diff --git a/mkdocs.yml b/mkdocs.yml index 76940184b..5076423a7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -43,6 +43,7 @@ nav: - Documentation Writer: development/docs-writer.md - Implementation Timeline: timeline.md - FAQ: faq.md + - Quick Start: quickstart.md - Reference: reference/ - Architecture Decision Records (ADRs): - Overview: adr/index.md @@ -73,7 +74,7 @@ nav: - ADR-025 Observability & Logging: adr/ADR-025-observability-and-logging.md - ADR-026 Agent-to-Agent Protocol (A2A): adr/ADR-026-agent-client-protocol.md - ADR-027 Language Server Protocol (LSP) Integration: adr/ADR-027-language-server-protocol.md - - ADR-028 Agent Skills Standard (AgentSkills.io): adr/ADR-028-agent-skills-standard.md + - ADR-028 Skill/Tool Abstraction Definition: adr/ADR-028-agent-skills-standard.md - ADR-029 Model Context Protocol (MCP) Adoption: adr/ADR-029-model-context-protocol.md - ADR-030 Skill Abstraction Definition: adr/ADR-030-skill-abstraction-definition.md - ADR-031 Actor Abstraction Definition: adr/ADR-031-actor-abstraction-definition.md