docs/wml-engine/readme.md
WaveNav Engine Docs
Purpose: implementation-ready documentation for a maintainable WaveNav WASM WML engine based on WML 1.1 semantics.
Canonical Docs
Use these as the current source of truth:
source-material-review.mdrequirements-matrix.mdarchitecture.mdticket-plan.mdtest-strategy.mdwork-items.mdwavescript-security.md../waves/RUNTIME_MARKUP_SPEC_TRACEABILITY.md../waves/CONTRACT_REQUIREMENTS_MAPPING.md../waves/SPEC_TEST_COVERAGE.md
Non-authoritative historical docs are retained only for context:
implementation-tickets.md../wml-1.1-engine-support-plan.md
Read Order
spec-derived-requirements.md(what must be true)source-material-review.md(what was extracted from the reviewed canonical local PDFs)requirements-matrix.md(normative requirement -> module -> tests)architecture.md(how to structure the engine)ticket-plan.md(step-by-step spec-referenced backlog)work-items.md(execution-ready tickets for current build cycle)test-strategy.md(how to verify behavior)wavescript-security.md(sandbox and safety controls)source-material-triage.md(full-corpus triage context)implementation-tickets.md(older backlog draft; superseded byticket-plan.md)
Reference-Only Material (not implementation-ready)
HISTORICAL_QUIRKS.md/historical-quirks.json: source-cited catalogue of documented WAP browser divergences from the WML spec (Openwave/Nokia/Ericsson/Motorola era). Research reference for a possible future compatibility-profile feature – does not affect current runtime behavior, and must not be treated as authoritative until explicitly promoted per that doc’s own promotion rule.COMPATIBILITY_PROFILE_DESIGN_NOTES.md: proposed architecture (profile struct shape, build order, test corpus) for the same possible future feature. Design reference only, not implemented.
Scope Philosophy
- Start with a strict MVP that renders and navigates cards correctly.
- Keep interfaces stable and internal modules replaceable.
- Add advanced semantics in phases (do/go/prev/refresh, variables, forms, timers/events).