Skip to content

Commit 3e832f4

Browse files
authored
docs: remove stale cmd/eyrie/ doc references (#29)
The eyrie/docs/ARCHITECTURE.md Components diagram and the README.md build instructions both referenced a cmd/eyrie/ directory that does not exist — eyrie is a library, not a CLI. Reword the docs to reflect the library-only reality: - docs/ARCHITECTURE.md: drop the 'cmd/eyrie/' tree entry, keep the api/openapi.yaml entry (the OpenAPI spec documents the embedded HTTP server in internal/api, not a standalone binary). - README.md: replace 'go build ./cmd/eyrie' with 'go build ./...' to match Makefile:46 (the build target is just 'go build ./...' to verify the library compiles).
1 parent 379cee8 commit 3e832f4

2 files changed

Lines changed: 2 additions & 3 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ eyrie is part of the hawk-eco:
285285
### Build & Test
286286

287287
```bash
288-
go build ./cmd/eyrie # Build binary
288+
go build ./... # Verify the library compiles
289289
go test -race ./... # Run all tests with race detector
290290
make ci # Run full CI suite (lint, test, security)
291291
make cover # Generate coverage report

docs/ARCHITECTURE.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ eyrie is the LLM provider runtime for the hawk ecosystem. It sits between the ap
2424

2525
```
2626
eyrie/
27-
├── cmd/eyrie/ ⚡ Entry point — CLI arg parsing, server startup
28-
├── api/openapi.yaml 📜 REST API contract (OpenAPI 3.1)
27+
├── api/openapi.yaml 📜 REST API contract (OpenAPI 3.1) — embedded HTTP server surface
2928
├── client/
3029
│ ├── client.go 🔌 Provider interface + EyrieClient factory
3130
│ ├── anthropic.go 🟠 Anthropic Claude provider

0 commit comments

Comments
 (0)