docs: add quick start guide (PR #9245)
CI / helm (pull_request) Successful in 33s
CI / build (pull_request) Successful in 52s
CI / lint (pull_request) Successful in 1m3s
CI / quality (pull_request) Successful in 1m26s
CI / typecheck (pull_request) Successful in 1m29s
CI / security (pull_request) Successful in 1m33s
CI / push-validation (pull_request) Successful in 22s
CI / e2e_tests (pull_request) Successful in 3m26s
CI / integration_tests (pull_request) Successful in 4m43s
CI / unit_tests (pull_request) Failing after 6m22s
CI / docker (pull_request) Has been skipped
CI / coverage (pull_request) Successful in 10m46s
CI / status-check (pull_request) Failing after 4s
CI / helm (pull_request) Successful in 33s
CI / build (pull_request) Successful in 52s
CI / lint (pull_request) Successful in 1m3s
CI / quality (pull_request) Successful in 1m26s
CI / typecheck (pull_request) Successful in 1m29s
CI / security (pull_request) Successful in 1m33s
CI / push-validation (pull_request) Successful in 22s
CI / e2e_tests (pull_request) Successful in 3m26s
CI / integration_tests (pull_request) Successful in 4m43s
CI / unit_tests (pull_request) Failing after 6m22s
CI / docker (pull_request) Has been skipped
CI / coverage (pull_request) Successful in 10m46s
CI / status-check (pull_request) Failing after 4s
Add docs/quickstart.md, update mkdocs navigation, and update CHANGELOG.md to address reviewer request.
This commit is contained in:
@@ -384,3 +384,7 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
|
|||||||
- BDD test suite (Behave + Robot Framework).
|
- BDD test suite (Behave + Robot Framework).
|
||||||
- Nox automation for lint, typecheck, tests, docs, benchmarks.
|
- Nox automation for lint, typecheck, tests, docs, benchmarks.
|
||||||
- MkDocs-powered documentation with CleverAgents branding.
|
- MkDocs-powered documentation with CleverAgents branding.
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- docs: Add quick start guide (docs/quickstart.md) and mkdocs navigation entry (PR #9245)
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
||||||
|
|
||||||
+2
-1
@@ -43,6 +43,7 @@ nav:
|
|||||||
- Documentation Writer: development/docs-writer.md
|
- Documentation Writer: development/docs-writer.md
|
||||||
- Implementation Timeline: timeline.md
|
- Implementation Timeline: timeline.md
|
||||||
- FAQ: faq.md
|
- FAQ: faq.md
|
||||||
|
- Quick Start: quickstart.md
|
||||||
- Reference: reference/
|
- Reference: reference/
|
||||||
- Architecture Decision Records (ADRs):
|
- Architecture Decision Records (ADRs):
|
||||||
- Overview: adr/index.md
|
- Overview: adr/index.md
|
||||||
@@ -73,7 +74,7 @@ nav:
|
|||||||
- ADR-025 Observability & Logging: adr/ADR-025-observability-and-logging.md
|
- 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-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-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-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-030 Skill Abstraction Definition: adr/ADR-030-skill-abstraction-definition.md
|
||||||
- ADR-031 Actor Abstraction Definition: adr/ADR-031-actor-abstraction-definition.md
|
- ADR-031 Actor Abstraction Definition: adr/ADR-031-actor-abstraction-definition.md
|
||||||
|
|||||||
Reference in New Issue
Block a user