Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -383,6 +383,11 @@ Documentation is split by audience:
- **DEVELOPMENT.md** — contributor-facing: internal architecture, design decisions, how to extend, testing
- **Source code** (`///` and `//!`) — implementation details co-located with code
- **`docs/`** — cross-cutting topics: performance, benchmarks, transactions, comparisons
- **`docs/superpowers/`** — planning artifacts kept in-repo and committed: design specs
under `docs/superpowers/specs/YYYY-MM-DD-<topic>-design.md` and their implementation
plans under `docs/superpowers/plans/YYYY-MM-DD-<feature>.md`. Non-trivial features are
brainstormed into a spec, then a plan, before code; keeping both in the repo makes the
design rationale reviewable alongside the change that implements it.

All public items have `///` doc comments. Module-level docs (`//!`) explain architecture and patterns. Examples are in `hyperdb-api/examples/` and tested via `run_all_examples.sh`. Companion crate examples in `hyperdb-api-salesforce/examples/` and `sea-query-hyperdb/examples/`. API docs are generated via `make doc`.

Expand Down
9 changes: 9 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# CLAUDE.md — hyper-api-rust

This project's agent guidance — architecture, build/test commands, the `hyperd`
bootstrap, conventions, and the numbered codebase-specific reminders (including
"don't invent `hyperd` flags" and "never report a test as passing without real
output") — lives in `AGENTS.md`. It is the cross-tool source of truth; this file
exists only so Claude Code auto-loads it.

@AGENTS.md
Loading
Loading