docs: add quick start guide (PR #9245)
CI / status-check (pull_request) Blocked by required conditions
CI / lint (pull_request) Successful in 1m5s
CI / typecheck (pull_request) Successful in 1m23s
CI / quality (pull_request) Successful in 1m27s
CI / benchmark-publish (pull_request) Has been skipped
CI / security (pull_request) Successful in 1m34s
CI / helm (pull_request) Successful in 38s
CI / push-validation (pull_request) Successful in 29s
CI / build (pull_request) Successful in 46s
CI / benchmark-regression (pull_request) Failing after 39s
CI / integration_tests (pull_request) Successful in 3m21s
CI / e2e_tests (pull_request) Successful in 3m20s
CI / unit_tests (pull_request) Successful in 6m36s
CI / docker (pull_request) Failing after 1s
CI / coverage (pull_request) Failing after 16m55s

Add docs/quickstart.md with end-to-end quick start guide covering
prerequisites, installation, project creation, resource registration,
plan/apply workflow, and troubleshooting.

Update mkdocs.yml navigation to include Quick Start page and rename
ADR-028 title to Skill/Tool Abstraction Definition.

Update CHANGELOG.md with quick start guide entry.

Closes #9245
This commit is contained in:
2026-05-04 19:21:46 +00:00
parent 6236d6fc4f
commit fcafb671d3
3 changed files with 46 additions and 1 deletions
+1
View File
@@ -31,6 +31,7 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
### Added
- **Quick Start Guide** (PR #9245): Added `docs/quickstart.md` with an end-to-end quick start guide covering prerequisites, installation, project creation, resource registration, plan/apply workflow, and troubleshooting. Updated `mkdocs.yml` navigation to include the Quick Start page.
- **Plan checkpoint management CLI commands** (#8683): Added `agents plan checkpoint-list <plan-id>` and `agents plan checkpoint-delete <checkpoint-id>` commands. Listing output now highlights checkpoint ID, type, created timestamp, reason, phase, and decision linkage with a concise field summary footer across rich/table/json/yaml formats. Deletion supports batch IDs, interactive confirmation (skip with `--yes`), and structured JSON/YAML responses for automation-friendly scripting.
- **Invariant Remove CLI Command** (#8530): Implemented `agents invariant remove <id>` command that soft-deletes an invariant by ID. The command displays a confirmation prompt before removal (bypassable with `--yes`/`-y`), outputs the removed invariant ID on success, and shows a clear error message when the invariant ID does not exist. Supports `--format` flag for JSON and YAML output. Full BDD test coverage and Robot Framework integration tests included.
+43
View File
@@ -0,0 +1,43 @@
# 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
View File
@@ -60,6 +60,7 @@ nav:
- Reference/Command Input & Sessions: tui/input-and-sessions.md
- Configuration, Key Bindings & Integration: tui/configuration-and-integration.md
- FAQ: faq.md
- Quick Start: quickstart.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Reference: reference/
@@ -92,7 +93,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