P0-REL-D: Documentation — README, CONTRIBUTING, CHANGELOG, User Guide, CLI Reference

[DingmaomaoBJTU]

Summary

Write and finalize all public-facing documentation: README, CONTRIBUTING, CHANGELOG, end-to-end user guide, CLI command reference, and support docs.

Context

Documentation must be complete by May 19. This is a gating requirement for public release — users cannot onboard without it. From plans/release/0501_release_plan/release.md.

Tasks (D-01 ~ D-08)

• D-01: Write/finalize top-level README.md — project overview, quick start, badges, trademark notice, telemetry notice (required by L-05, L-06)
• D-02: Write CONTRIBUTING.md — dev setup, coding standards, PR process; must include CLA mention; include uv setup, ruff, pytest instructions
• D-03: Write CHANGELOG.md with initial release notes (v0.1.0) — follow Keep a Changelog format; include all P0 features
• D-04: Add inline docstrings to all public API functions and classes (Google or NumPy style)
• D-05: Publish API reference documentation (Sphinx / MkDocs) — target: GitHub Pages or ReadTheDocs
• D-06: Write end-to-end user guide (load → export → optimize → perf) — at least one worked example covering the core CLI workflow
• D-07: Document all CLI commands (wmk build, wmk perf, wmk debug, wmk hub) — flags, examples, expected output
• D-08: Add SUPPORT.md using Microsoft repo-templates/SUPPORT.md — how to get help vs file a bug

Acceptance Criteria

• README: passes readability check (install + first run in < 5 minutes from README)
• CONTRIBUTING: CLA mention present; uv + ruff + pytest setup instructions complete
• CHANGELOG: v0.1.0 release notes cover all P0 features
• All public API functions have docstrings
• API reference deployed and accessible
• User guide: at least one E2E worked example (HuggingFace model → wmk build → wmk perf)
• CLI reference: all current commands documented with examples
• SUPPORT.md committed using MS template

Technical Notes

• README must include trademark notice (L-05) and telemetry notice (L-06)
• D-05: use MkDocs + mkdocstrings for Python API auto-docs (integrates with uv)
• D-07: wmk run is explicitly deferred — do NOT document it as available

Related Files

• plans/release/0501_release_plan/release.md — D-01 ~ D-08 task details
• P0-REL-L — L-05 (trademark), L-06 (telemetry) requirements that affect README