docs: align documentation with actual framework behavior#156
Merged
Conversation
Audit all project docs against the real scripts, package.json, docker-compose.yml, .mcp.json and the packages/ monorepo, and bring them into line with reality: - Versioning: package.json is release-please-managed (1.12.0), not pinned to 0.0.0 - MCP: repoint chrome-devtools references to the configured Playwright MCP + lhci - Onboarding: add the required `cp .env.example .env` step; fix admin/changeme login; list pnpm as a prerequisite; bump documented Node minimum to 20 (matches engines) - Catalogs: unify agent count to 53, skills to 12, plugins to 6; add 3 missing agents - Document the flavian CLI, init wizard, @flavian/pipeline and @flavian/gui in CLAUDE.md - Reframe the stale "code-reviewer" naming-conflict guidance as conditional - Correct "automatic" validation hooks to manual/agent-run; fix paths, links and counts - Remove two outdated 2026-01-23 documentation-reorg planning docs Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
PAMulligan
added
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Comprehensive audit of all project documentation against the actual implementation (scripts,
package.json,docker-compose.yml,.mcp.json, thepackages/monorepo, and CI), correcting every discrepancy found. 44 files changed: 42 docs updated, 2 stale planning docs removed (DOCUMENTATION-AUDIT.md,DOCUMENTATION-REORGANIZATION-COMPLETE.md).The audit ran as 7 parallel verification streams; pipeline/GUI and the headless/multisite/WooCommerce feature docs were already accurate, so most changes concentrate on versioning, onboarding, MCP references, and stale counts.
Key corrections
README.mdandCONTRIBUTING.mdclaimedpackage.jsonis intentionally pinned to0.0.0. It is release-please-managed (1.12.0, mirrored intopackage.jsonandpackages/gui/package.jsonviaextra-files).accessibility-auditor,seo-schema-agent,visual-qa-agent) referenced achrome-devtoolsMCP server that.mcp.jsondoesn't configure. Repointed to the configured Playwright MCP +lhci(pnpm lighthouse:run) for Lighthouse.QUICK-START/LOCAL-DEVELOPMENT/PREREQUISITESnow include the requiredcp .env.example .envstep, the correctadmin/changemelogin, and pnpm as a prerequisite.check-prerequisites.sh, matchingengines(≥20) and CI (20/22).CUSTOM-AGENTS-GUIDE.mdhad three conflicting agent totals (53/45/49); unified to 53 (26 WordPress + 27 generic) with 3 missing agents catalogued. Skills corrected to 12 inskills/README.mdandPLUGINS-REFERENCE.md;SETUP-COMPLETE.mdto 6 plugins / 53 agents and root-levelthemes/.CLAUDE.mdnow covers theflavianCLI,pnpm run initwizard,@flavian/pipeline, and@flavian/gui.code-reviewernaming-conflict guidance as conditional; corrected "automatic" validation hooks to manual/agent-run; fixed pipeline test paths, broken links,cross-browser-test.sharg order,docker-compose→docker compose; removed leftover authoring scaffolding fromPATTERN-FIRST-ARCHITECTURE.md.Type of Change
Checklist
check-prerequisites.sh, aligned topackage.jsonengines🤖 Generated with Claude Code