Skip to content

README.md

Latest commit

 

History

History
71 lines (60 loc) · 3.01 KB

README.md

File metadata and controls

71 lines (60 loc) · 3.01 KB
Raw

Reference

Reference docs describe current commands, configuration, runtime contracts, generated metadata, and integration boundaries. Start with the Documentation Hub; for task-oriented examples, use the Native Cookbook.

CLI And Project Shape

  • CLI: current gowdk command and flag surface.
  • Config: current Go config types, addons, modules, and build target fields.
  • Dev Server: rebuild, live reload, generated-app restart, overlay, and HMR behavior.
  • Deployment: output shapes, generated binaries, Docker, and optional operations recipes.
  • Testing: scaffolded smoke tests, generated-app tests, browser smoke, accessibility, and performance checks.

Language And Generated Output Contracts

  • Routing: route declarations, dynamic route behavior, and output paths.
  • Validation: request and form validation boundaries.
  • Manifest: current manifest JSON.
  • Go Interop: Go binding, build-data, typed parameter, and stub-generation behavior.
  • Hooks: lifecycle services, middleware, guard, and rate-limit ordering.
  • Errors: error pages, panic boundaries, and cache policy.
  • Diagnostics: diagnostic output formats.
  • Diagnostic Codes: diagnostic registry, stability, and gowdk explain.

Runtime And Addons

  • Addons: addon feature registration and discovery.
  • Contracts: runtime contract registry and generated command/query adapters.
  • Realtime: presentation-event fanout, SSE default, and WebSocket opt-in behavior.
  • Tracing: dependency-free trace IDs, spans, sinks, sampling, propagation, and local collection.
  • Observability: generated tracing addon and debug-gated instrumentation.
  • Database: database addon conventions and app-owned boundaries.
  • Framework Integrations: optional adapter integration notes.

Frontend And Metadata

  • CSS: CSS inputs, processors, scoped output, and extension points.
  • Images: image optimization patterns and current non-goals.
  • SEO: sitemap, robots, metadata, and structured-data behavior.
  • PWA And Offline: user-owned service worker and manifest guidance.

Sources Of Truth

  • Accepted .gwdk syntax and semantics live under Language.
  • Compiler pipeline and generated-output details live under Compiler.
  • Product capability status lives in Requirements.
  • Product direction and feature specifications live under Product.
  • Architecture, production hardening, and operations guidance live under Engineering.
  • Runnable examples and recipes live in the Cookbook and Examples Index.