DNotes Documentation¶

DNotes is an API-first MVP for collecting developer notes, generating local embeddings, and grouping notes into topics.

Project Docs¶

• Project README
• OpenAPI specification
• Critical codebase review

Local Startup¶

docker compose up --build

Local Services¶

• Go API: http://localhost:8080
• PostgreSQL with pgvector: localhost:5432
• Local embedding service: http://localhost:8000

Important Local URLs¶

• GET /
• GET /app
• GET /healthz
• GET /readyz
• GET /openapi.yaml

API Areas¶

• Health: liveness and readiness checks.
• Notes: note collection, storage, embedding, and assignment.
• Topics: topic grouping and centroid-based matching.
• Documentation: project docs and OpenAPI specification access.

Key Concepts¶

• Notes are embedded locally by the embedding sidecar.
• Topic assignment uses cosine similarity against existing topic centroids.
• Notes below the threshold can remain unclear for manual review.
• Manual assignment overrides automatic assignment.

Development Commands¶

go fmt ./...
go test ./...
go test -race ./...
go generate ./...
docker compose config
docker compose build