Platform-level documentation for appget.dev, applicable across all language implementations. For language-specific docs, see the subproject directories (e.g., java/).
Files in docs/ follow a two-tier structure:
| Location | Meaning |
|---|---|
docs/*.md |
Active — describes implemented behavior. Authoritative reference. |
docs/todos/*.md |
Pending — not yet implemented, future specs, or tracked gaps. |
See the root CLAUDE.md for the full lifecycle rules.
| Document | Purpose |
|---|---|
| DESIGN.md | Architecture rationale — the "why" behind every pipeline decision |
| PIPELINE.md | Language-agnostic pipeline overview — entry point for new language implementations |
| GHERKIN_GUIDE.md | Gherkin DSL reference — keywords, operators, patterns, and complete University domain examples |
Implemented in Java today. All future language targets must conform. Minor gaps tracked in todos/CONTRACT_GAPS.md.
| Document | Purpose |
|---|---|
| MODELS_YAML_SCHEMA.md | models.yaml schema — field types, ordering, field number stability |
| SPECS_YAML_SCHEMA.md | specs.yaml schema — rules, conditions, metadata, operators |
| REST_CONTRACT.md | REST naming, CRUD endpoints, rule responses, error codes |
| DECIMAL.md | Decimal proto message and per-language type mappings |
| PROTO_CONVENTIONS.md | Proto file naming, package names, language options |
Entry point: ROADMAP.md — every pending doc maps to a roadmap phase.
| Document | Phase | Status | Purpose |
|---|---|---|---|
| 0a | Done (2026-03-29) | NamingConvention interface — dev.appget.naming package with cross-language field-name resolution pattern |
|
| 0b | Done (2026-04-02) | ServerEmitter interface + SpringBootEmitter — AppServerGenerator is now a framework-agnostic orchestrator | |
| GRPC_CONTRACT.md | 0c | Pending | gRPC server implementation (proto stubs exist, server pending) |
| 0d | Done (2026-04-02) | Static HTML CRUD pages — HtmlCrudGenerator, 67 pages, 23 tests | |
| SPEC-multi-industry-verification.md | 0e | Pending | Multi-industry verification harness — prove Java works across verticals (depends on 0f) |
| 0g | Done (2026-04-05) | Codegen package refactoring — all 28 findings resolved (portability violations, duplication, reflection, mutable fields) | |
| SPEC-content-negotiation.md | 0f | Ready | Accept-header content negotiation — PageRenderer + templates architecture (research complete, spec finalized 2026-04-03) |
| Document | Phase | Purpose |
|---|---|---|
| PARSER_PARITY.md | 1 | Rules for byte-for-byte identical parser output across languages |
| CONFORMANCE_TESTS.md | 1 | Cross-language fixture layout and golden outputs |
| LANGUAGE_IMPLEMENTATION.md | 5-6 | Framework selections and implementation guide per language |
| CONTRACT_GAPS.md | 5 | Remaining gap (GAP-P1): non-Java package options, blocked on language implementations |