Phase 7: documentation scaffold and README improvements #18

New issue

Closed

opened 2026-06-11 04:52:42 +00:00 by coding-agent-marvin8 · 1 comment

coding-agent-marvin8 commented

2026-06-11 04:52:42 +00:00

(Migrated from codeberg.org)

WuMing Phases 1–6 are complete and tested. Phase 7 finalises user-facing documentation before the 0.1.0 release.

The following items need addressing:

README.md is missing a section on how WuMing handles large PRs — the size gate (WUMING_MAX_DIFF_LINES) and the hunk-size cap (300-line threshold). Users need to understand this behaviour to tune their setup.
A docs/ directory does not exist. A structured, user-facing documentation scaffold is needed: at minimum a deployment guide for Woodpecker CI, a full configuration reference, and an agents reference.
ROADMAP.md needs Phase 5 marked complete (heading is missing its ✓ even though all items are done) and Phase 7 items marked done once this work lands.
pyproject.toml needs a docs optional-dependency group for mkdocs-material so contributors can build the docs locally.

WuMing Phases 1–6 are complete and tested. Phase 7 finalises user-facing documentation before the 0.1.0 release. The following items need addressing: 1. README.md is missing a section on how WuMing handles large PRs — the size gate (WUMING_MAX_DIFF_LINES) and the hunk-size cap (300-line threshold). Users need to understand this behaviour to tune their setup. 2. A docs/ directory does not exist. A structured, user-facing documentation scaffold is needed: at minimum a deployment guide for Woodpecker CI, a full configuration reference, and an agents reference. 3. ROADMAP.md needs Phase 5 marked complete (heading is missing its ✓ even though all items are done) and Phase 7 items marked done once this work lands. 4. pyproject.toml needs a docs optional-dependency group for mkdocs-material so contributors can build the docs locally.

coding-agent-marvin8 commented

2026-06-11 04:53:03 +00:00

(Migrated from codeberg.org)

Exploration findings and plan of attack:

Current state:

README.md (73 lines) already has all WUMING_* env vars and the agents table, but no prose section on large-PR handling.
CLAUDE.md is current — env var list, project layout (including security.py), and AGENT_REGISTRY all accurate. No changes needed there.
No docs/ directory exists.
ROADMAP.md Phase 5 heading lacks ✓; Phase 7 items are all [ ].

Plan of attack:

README.md — add a ## Handling large PRs prose section covering:
- Size gate (WUMING_MAX_DIFF_LINES): posts a single plain comment and exits when diff exceeds the limit; disabled at 0 (default).
- Hunk size cap: hunks > 300 lines are summarised before being sent to the agent; file metadata and hunk header are preserved.
docs/ scaffold modelled on the zaojun project (mkdocs.yml + Material theme):
- docs/index.md
- docs/getting-started/deploying-on-woodpecker.md (prerequisites, minimal YAML, secrets setup, backend choice, agent selection, large-PR tuning)
- docs/reference/configuration.md (grouped env-var table: Required / Backend / Tuning / CI-injected)
- docs/reference/agents.md (per-agent: file patterns, focus, model notes)
- docs/about/license.md
ROADMAP.md — add ✓ to Phase 5 heading; mark all Phase 7 [ ] items [x]; add ✓ to Phase 7 heading.
pyproject.toml — add [project.optional-dependencies] docs = ["mkdocs-material>=9"].

Branch: feat/issue-18-phase7-docs

Commits:

📝 README: add Handling large PRs section
📝 add docs/ scaffold — mkdocs.yml and five content pages
📝 ROADMAP: mark Phase 5 and Phase 7 complete
🔧 pyproject.toml: add docs optional-deps for mkdocs-material

Verification: uv run nox + uv run --with mkdocs-material mkdocs build --strict

Exploration findings and plan of attack: **Current state:** - README.md (73 lines) already has all WUMING_* env vars and the agents table, but no prose section on large-PR handling. - CLAUDE.md is current — env var list, project layout (including security.py), and AGENT_REGISTRY all accurate. No changes needed there. - No docs/ directory exists. - ROADMAP.md Phase 5 heading lacks ✓; Phase 7 items are all [ ]. **Plan of attack:** 1. README.md — add a `## Handling large PRs` prose section covering: - Size gate (WUMING_MAX_DIFF_LINES): posts a single plain comment and exits when diff exceeds the limit; disabled at 0 (default). - Hunk size cap: hunks > 300 lines are summarised before being sent to the agent; file metadata and hunk header are preserved. 2. docs/ scaffold modelled on the zaojun project (mkdocs.yml + Material theme): - docs/index.md - docs/getting-started/deploying-on-woodpecker.md (prerequisites, minimal YAML, secrets setup, backend choice, agent selection, large-PR tuning) - docs/reference/configuration.md (grouped env-var table: Required / Backend / Tuning / CI-injected) - docs/reference/agents.md (per-agent: file patterns, focus, model notes) - docs/about/license.md 3. ROADMAP.md — add ✓ to Phase 5 heading; mark all Phase 7 [ ] items [x]; add ✓ to Phase 7 heading. 4. pyproject.toml — add `[project.optional-dependencies] docs = ["mkdocs-material>=9"]`. **Branch:** feat/issue-18-phase7-docs **Commits:** 1. :memo: README: add Handling large PRs section 2. :memo: add docs/ scaffold — mkdocs.yml and five content pages 3. :memo: ROADMAP: mark Phase 5 and Phase 7 complete 4. :wrench: pyproject.toml: add docs optional-deps for mkdocs-material **Verification:** uv run nox + uv run --with mkdocs-material mkdocs build --strict

No labels

No milestone

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference

marvin8/wuming#18

No description provided.

Rows
Columns