Skip to content

Commit b58c9ce

Browse files
committed
docs: reorganize README into focused guides and add concord-database skill
Slim README from 3155 lines to 145 lines, extracting all detailed content into dedicated docs/ guides for hex docs: - getting-started.md: installation, quick start, common use cases - elixir-guide.md: consistency levels, CAS, queries, compression, API ref - observability.md: telemetry, prometheus, tracing, audit, event streaming - backup-restore.md: CLI and programmatic backup/restore - configuration.md: all config options and environment variables - deployment.md: Docker, K8s, security, operations, FAQ, troubleshooting Update mix.exs to include all new docs in hex docs with grouped navigation. Add concord-database skill (skills/concord-database/) for AI agents with SKILL.md core guide and references/ for API, state machine, and HTTP API. Add /update-concord-database-skill command to refresh the skill from source.
1 parent eb79a01 commit b58c9ce

File tree

13 files changed

+2786
-3103
lines changed

13 files changed

+2786
-3103
lines changed
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
Perform a fresh, comprehensive analysis of the Concord project and update the concord-database skill at `skills/concord-database/`.
2+
3+
## Analysis Steps
4+
5+
1. **Read all source files** to capture the current state of the codebase:
6+
- `lib/concord.ex` — All public API functions, options, return types
7+
- `lib/concord/state_machine.ex` — All commands, queries, state shape, snapshot logic
8+
- `lib/concord/auth.ex` — Auth API
9+
- `lib/concord/rbac.ex` — RBAC API
10+
- `lib/concord/multi_tenancy.ex` — Multi-tenancy API
11+
- `lib/concord/index.ex` and `lib/concord/index/extractor.ex` — Index API and extractor specs
12+
- `lib/concord/backup.ex` — Backup/restore API
13+
- `lib/concord/ttl.ex` — TTL management
14+
- `lib/concord/query.ex` — Query language API
15+
- `lib/concord/event_stream.ex` — Event streaming API
16+
- `lib/concord/compression.ex` — Compression API
17+
- `lib/concord/web/router.ex` and `lib/concord/web/authenticated_router.ex` — HTTP routes
18+
- `lib/concord/web/api_controller.ex` — HTTP handler details
19+
- `lib/concord/application.ex` — Supervisor tree
20+
- `config/config.exs` — All configuration options
21+
- `config/runtime.exs` — Runtime configuration
22+
- `CLAUDE.md` — Correctness invariants and architecture
23+
- `mix.exs` — Dependencies and aliases
24+
25+
2. **Compare with current skill** — Read existing skill files:
26+
- `skills/concord-database/SKILL.md`
27+
- `skills/concord-database/references/api-reference.md`
28+
- `skills/concord-database/references/state-machine.md`
29+
- `skills/concord-database/references/http-api.md`
30+
31+
3. **Update all skill files** to reflect any changes:
32+
- New/removed/changed API functions
33+
- New/changed state machine commands or queries
34+
- New/changed HTTP endpoints
35+
- Updated configuration options
36+
- New modules or features
37+
- Updated correctness invariants
38+
- Changed testing patterns
39+
40+
## Guidelines
41+
42+
- Keep SKILL.md concise (<500 lines) — it shares context window space
43+
- Use imperative/infinitive form in instructions
44+
- Include only information an AI agent wouldn't already know
45+
- Ensure all code examples match actual source code signatures
46+
- Verify correctness invariants still match CLAUDE.md
47+
- Update references/ files with detailed information
48+
- Do NOT create README.md or other auxiliary files

0 commit comments

Comments
 (0)