vikingowl
5170c73dac
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).
43 lines
1.8 KiB
Markdown
43 lines
1.8 KiB
Markdown
---
|
|
project: gnoma
|
|
layout: directory
|
|
path: docs/essentials/
|
|
essentials:
|
|
vision: complete
|
|
domain-model: complete
|
|
architecture: complete
|
|
patterns: complete
|
|
process-flows: complete
|
|
uml-diagrams: complete
|
|
api-contracts: complete
|
|
tech-stack: complete
|
|
constraints: complete
|
|
milestones: complete
|
|
decision-log: complete
|
|
risks: complete
|
|
---
|
|
|
|
# Project Essentials — gnoma
|
|
|
|
| # | Essential | Status | Link | Last Updated |
|
|
|---|-----------|--------|------|-------------|
|
|
| 1 | Vision | complete | [vision.md](vision.md) | 2026-04-03 |
|
|
| 2 | Domain Model | complete | [domain-model.md](domain-model.md) | 2026-04-03 |
|
|
| 3 | Architecture | complete | [architecture.md](architecture.md) | 2026-04-03 |
|
|
| 4 | Patterns | complete | [patterns.md](patterns.md) | 2026-04-03 |
|
|
| 5 | Process Flows | complete | [process-flows.md](process-flows.md) | 2026-04-03 |
|
|
| 6 | UML Diagrams | complete | [uml-diagrams.md](uml-diagrams.md) | 2026-04-03 |
|
|
| 7 | API Contracts | complete | [api-contracts.md](api-contracts.md) | 2026-04-03 |
|
|
| 8 | Tech Stack & Conventions | complete | [tech-stack.md](tech-stack.md) | 2026-04-03 |
|
|
| 9 | Constraints & Trade-offs | complete | [constraints.md](constraints.md) | 2026-04-03 |
|
|
| 10 | Milestones | complete | [milestones.md](milestones.md) | 2026-04-03 |
|
|
| 11 | Decision Log | complete | [decisions/001-initial-decisions.md](decisions/001-initial-decisions.md) | 2026-04-03 |
|
|
| 12 | Risk / Unknowns | complete | [risks.md](risks.md) | 2026-04-03 |
|
|
|
|
## Architecture Decision Records
|
|
|
|
- [ADR-001 — Initial Decisions](decisions/001-initial-decisions.md)
|
|
- [ADR-002 — SLM Routing](decisions/002-slm-routing.md)
|
|
- [ADR-003 — Plugin Trust via TOFU Manifest Pinning](decisions/003-plugin-trust.md)
|
|
- [ADR-004 — PostToolUse Hook Ordering](decisions/004-posttooluse-hook-ordering.md)
|