Files
gnoma/docs/essentials/INDEX.md
T
vikingowl 5170c73dac docs: refresh README/CONTRIBUTING/AGENTS/TODO, add LICENSE, drop obsolete files
Top-level docs were stale and the .gitea/ issue templates referenced a
workflow that is no longer in use.

- README: rewrite around the current feature set (SLM routing, profiles,
  plugin TOFU, SafeProvider boundary, current model defaults). Add a
  pre-built-binary install section plus Docker (ghcr.io) install path
  for users without a Go toolchain. Document the GitHub mirror.
- CONTRIBUTING: drop the dead issue-template reference, note Gitea
  upstream + GitHub mirror split, expand the package map and test-target
  table.
- AGENTS: rebuild as a domain glossary (Elf / Arm / Turn / SafeProvider /
  Incognito / Profile) plus non-obvious conventions an outside agent
  needs and would not infer from the code.
- TODO: trim completed waves into a History section, fix a broken
  link to the never-written Wave 3 plan file, surface active backlog.
- docs/essentials/INDEX: add ADR-004 (PostToolUse hook ordering) to the
  ADR list.
- LICENSE + NOTICE: adopt Apache License 2.0. Patent grant matters
  because gnoma bundles SDKs from Anthropic / OpenAI / Google / Mistral
  and ships derivative tooling that runs untrusted MCP servers.
- Delete .gitea/issue_template/ and gemma-integration-analysis.md
  (latter is obsolete per its own preamble — Node.js-specific notes
  that don't apply to the Go implementation).
2026-05-20 03:13:40 +02:00

1.8 KiB

project, layout, path, essentials
project layout path essentials
gnoma directory docs/essentials/
vision domain-model architecture patterns process-flows uml-diagrams api-contracts tech-stack constraints milestones decision-log risks
complete complete complete complete complete complete complete complete complete complete complete complete

Project Essentials — gnoma

# Essential Status Link Last Updated
1 Vision complete vision.md 2026-04-03
2 Domain Model complete domain-model.md 2026-04-03
3 Architecture complete architecture.md 2026-04-03
4 Patterns complete patterns.md 2026-04-03
5 Process Flows complete process-flows.md 2026-04-03
6 UML Diagrams complete uml-diagrams.md 2026-04-03
7 API Contracts complete api-contracts.md 2026-04-03
8 Tech Stack & Conventions complete tech-stack.md 2026-04-03
9 Constraints & Trade-offs complete constraints.md 2026-04-03
10 Milestones complete milestones.md 2026-04-03
11 Decision Log complete decisions/001-initial-decisions.md 2026-04-03
12 Risk / Unknowns complete risks.md 2026-04-03

Architecture Decision Records