Skip to content

Split README into user guide + reference docs #16

@darthfork

Description

@darthfork

The README is fine for a prototype, but an official ruleset should separate quickstart, API reference, toolchains, and design notes.

Tasks:

  • Keep README focused on overview and quick start.
  • Add docs/ for installation, rules reference, toolchains, platforms, and troubleshooting.
  • Document module-extension usage thoroughly.

Acceptance criteria:

  • Users can find install, API, and troubleshooting docs without reading source.

Parent issue: #5

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions