Skip to content

Docs: complete end-user and maintainer documentation #39

Description

@hyperpolymath

Goal

Complete human documentation across the end-user and maintainer audiences. (The developer quickstart was filled in #37; deep dev docs already exist in docs/developer/ABI-FFI-README.adoc.)

End-user (QUICKSTART-USER.adoc is an unfilled template)

  • Fill QUICKSTART-USER.adoc with a real worked example.
  • Tutorials: GDPR consent retrofit, WCAG 2.2 compliance, i18n retrofit.
  • wokelangiser.toml manifest schema reference (with examples).
  • FAQ / troubleshooting (incl. "why doesn't generate produce output yet?" — pre-alpha).

Maintainer (QUICKSTART-MAINTAINER.adoc is an unfilled template)

  • Fill QUICKSTART-MAINTAINER.adoc (packaging via Guix/Nix/container).
  • Release runbook (version bump, CHANGELOG, tag, publish).
  • Dependency-update policy (Rust/Idris2/Zig version bounds, cargo audit cadence).

Notes

  • docs/ is the canonical home; the GitHub wiki is empty (docs/wikis/ is a stub) — decide whether to retire the wiki references or wire up a sync.
  • theory/, whitepapers/, reports/ sections are intentional sketch stubs — leave until the research roadmap firms up.

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