Skip to content

docs: update site metadata and rebrand mkdocs config - #12

Merged
Million-mo merged 2 commits into
mainfrom
docs/optimize-readme-and-contributing
Aug 10, 2026
Merged

docs: update site metadata and rebrand mkdocs config#12
Million-mo merged 2 commits into
mainfrom
docs/optimize-readme-and-contributing

Conversation

@Million-mo

Copy link
Copy Markdown
Owner

Update mkdocs.yml site name/description/repo URLs from AgentPool to WolfHarness, preparing documentation deployment for verification.

- Replace all wolf1069b/agentpool URLs with wolf1069b/wolfharness
  (badges, git clone, contributors, citation)
- Update tagline to match GitHub About description
- Restructure roadmap into Project History (3 milestones) + Future Plans
- Add serve-agui and serve-api to Quick Start server section
- Update code examples to use WolfHarness class name with note
  about AgentPool backward-compatible alias
- Fix CONTRIBUTING.md title from 'AgentPool' to 'WolfHarness'
@Million-mo
Million-mo merged commit ac18b78 into main Aug 10, 2026
@opencode-agent

Copy link
Copy Markdown

No GitHub token is available in this environment, so I can't post the review via the API. Here is the synthesized review for PR #12.


Review: PR #12 — docs: update site metadata and rebrand mkdocs config

Verdict: Request changes. The PR's stated purpose (rebranding mkdocs.yml site metadata) is not actually done, and the README introduces code examples that reference a class that does not exist.

🔴 Blocking

  1. from wolfharness import WolfHarness does not existREADME.md:68,70,196,199. There is no WolfHarness class or alias anywhere in src/; src/wolfharness/__init__.py:18,64 exports only AgentPool (the class is AgentPool in src/wolfharness/delegation/pool.py:50). Copy-pasting these examples raises ImportError. Keep AgentPool in the snippets or add the alias in code first.

  2. The alias note is invertedREADME.md:77 claims "AgentPool remains available as a backward-compatible alias for WolfHarness." Since WolfHarness doesn't exist, this is the reverse of reality; there is no alias in either direction. This needs to be fixed or removed.

  3. PR title/body mismatch — Title and body say "update mkdocs.yml site name/description/repo URLs," but mkdocs.yml is untouched. It still has site_name: "AgentPool" (mkdocs.yml:1), the AgentPool-era description (:2), repo_url: https://github.com/Leoyzen/wolfharness/ (:3), and a stale copyright (:6). The core claimed change was never made.

🟠 Major

  1. Repo identity split across 4 URLs — After this PR the README badges point to wolf1069b/wolfharness (README.md:8-11), while mkdocs.yml:3 uses Leoyzen/wolfharness, src/wolfharness/__init__.py:39 (__url__) uses phil65/wolfharness, and the actual remote is Million-mo/agentpool. Pick one canonical repo and use it everywhere.

  2. Unverifiable roadmap claimsRFC-0058 (dynamic workflow, README.md:241) does not exist in docs/rfcs/ (STATUS tops out at RFC-0057); "Polyglot agent support (M6)" (README.md:244) is labeled Phase 5 in RFC-0050, not M6. Drop or correct these.

  3. Missing changelog entry — Per changelog/README.md:28-32, every logical change (including the "Docs" surface) needs a detail file under changelog/unreleased/, which doesn't exist yet.

  4. pool.get_agent("assistant") is staleREADME.md:200. AgentPool has no get_agent() method (use get_context()/create_session()).

🟢 Minor / noted

  • The rename version claim "v2.10+" (README.md:313) is wrong — the agentpool → wolfharness rename landed at v2.9.5 (git show e126b2da0:pyproject.toml). Pre-existing, but the PR rewrote the surrounding roadmap section without fixing it.
  • Positive: serve-agui/serve-api commands are real (src/wolfharness_cli/__main__.py:79-81); documentation.yml workflow exists; all README/CONTRIBUTING doc links (AGENTS.md, LICENSE, docs/meta/documentation-guide.md) resolve; CONTRIBUTING.md heading is clean with no stale "AgentPool" refs.

New%20session%20-%202026-08-10T03%3A12%3A40.436Z
opencode session  |  github run

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant