docs(v3.3): rework README + infographic for the knowledge plane era#54
Merged
Conversation
README:
- Repositions the lead: self-correction memory + knowledge plane on one
SQLite store, both auto-loaded on session boundaries.
- Replaces the v3.2-shaped tour with a 60-second tour that walks
init → page → ask → seed → research → embed → hybrid → council.
- "What's new in v3.3" is a focused table of the five new skills with
the post-review hardening notes (path-traversal guards, atomic seed
claim, Promise.allSettled, citation alignment).
- "What's inside" rewritten:
* Skills grouped (Knowledge plane / Quality gates / Memory /
Orchestration), all 33 listed.
* Commands include /wiki and reflect the 22-entry surface.
* Hook scripts table replaced with event roster + selected
high-leverage hooks (37 scripts across 24 events).
* Reference guides match docs/ contents (9 files).
- Adds Storage section: the SQLite tables under ~/.pro-workflow/, kill
switch path, project- vs global-scope wiki layout.
- Adds "Knowledge plane env" config block: WIKI_ROOT, embedding/council
provider env, loop budget overrides, GH_TOKEN.
- Updates Patterns to include Knowledge Plane, Multi-LLM Council,
Token Efficiency.
- Updates Comparison table counts: 33/8/22/24.
- Drops the standalone "What's New in v3.2" block (folded into the
changelog).
Infographic:
- Components grid: scripts 29 → 37.
- New ROW 1.5 "Knowledge Plane" with the five v3.3 skills as the hero
block plus a step-by-step Auto-research loop diagram (claim seed
→ fetch → compile → FTS-index → enqueue follow-ups, with halt
conditions noted).
- Skills section 10: 33 total, knowledge-plane rows highlighted, list
of "10 more" updated for upstream merges (token-efficiency,
bug-capture, module-map, plan-interrogate, design-rules etc.).
- "New in v3.2" tags demoted to plain "v3.2" pills now that v3.3 is
the lead.
- Footer date stamp May 2026.
Visual identity stays Anthropic coral (pro-workflow's existing
brand). iii DESIGN.md tokens not imported; only the principles
(zero decoration, type-first, sparse accent) were applied to the
rewrite.
Contributor
📝 WalkthroughWalkthroughComprehensive documentation rewrite emphasizing v3.3's SQLite-backed knowledge plane combining self-correction memory, persistent FTS5-indexed wikis, and auto-research loops. README hero, features, and architecture sections refreshed with expanded skill/agent/command tables; infographic updated with matching content, component counts, and Knowledge Plane details. Changesv3.3 Knowledge Plane Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://ghub.bbstale.com/avatars/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
README.md (1)
302-316: 💤 Low valueConsider specifying code fence language.
The storage directory structure is clearly documented. For better Markdown linting compliance, consider adding a language identifier to the fenced code block at line 303 (e.g.,
text orbash).📝 Optional Markdown polish
-``` +```text ~/.pro-workflow/🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 302 - 316, The fenced directory tree in README.md is missing a language identifier which can trigger markdown-lint warnings; update the code fence that wraps the "~/.pro-workflow/" block to include a language token such as "text" or "bash" (i.e., change ``` to ```text or ```bash) so the block is explicitly marked and linters/renderers handle it correctly.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@README.md`:
- Around line 302-316: The fenced directory tree in README.md is missing a
language identifier which can trigger markdown-lint warnings; update the code
fence that wraps the "~/.pro-workflow/" block to include a language token such
as "text" or "bash" (i.e., change ``` to ```text or ```bash) so the block is
explicitly marked and linters/renderers handle it correctly.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 671ef014-893a-48e4-9d66-afd064d0512e
📒 Files selected for processing (2)
README.mddocs/infographic.html
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.
Summary
Post-merge documentation rework. PR #53 shipped the v3.3 knowledge plane (5 new skills, schema additions, hooks). This PR makes the user-facing docs match what shipped.
Changes
README (
README.md)init → page → ask → seed → research → embed → hybrid → council./wiki(22 commands).docs/(9 files).~/.pro-workflow/layout, kill-switch path, scope rules.WIKI_ROOT, embedding/council provider env, loop budgets,GH_TOKEN.Infographic (
docs/infographic.html)v3.2pills.Visual identity
Anthropic coral palette retained (pro-workflow's existing brand). iii DESIGN.md tokens were available but not imported — only the principles (zero decoration, type-first, sparse accent) informed the rewrite. Pro-workflow is not an iii-ecosystem app, so importing the iii palette would have been brand drift.
Test plan
html.parser)ls skills/ | wc -letc. (33/8/22/37)wiki-builder,wiki-query,wiki-research-loop,llm-council,survey-generator) and/wikicommand representeddocs/infographic.htmlin a browser at 1200px widthSummary by CodeRabbit