Skip to content

[Feature] Documentation: guides, API reference and annotated examples #13

@ElioNeto

Description

@ElioNeto

Overview

Write comprehensive documentation covering the architecture, annotation system, CLI, configuration, and real-world examples.

Acceptance Criteria

  • Getting Started guide: install, scaffold, run first project
  • Annotation Reference: full spec for @Route, @Validate, @Auth, @Page
  • CLI Reference: all commands with flags and examples
  • vyx.yaml Reference: all configuration keys documented
  • Architecture Overview: how core, workers, and IPC interact
  • Examples: Node.js + Zod, Python + Pydantic, React SSR page with auth
  • Docs hosted via GitHub Pages or a dedicated site

References

  • Spec §12 – Use Cases and Examples
  • Roadmap – Phase 3

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions