docs(research): refresh fallow.md + scan against current ship state#36
docs(research): refresh fallow.md + scan against current ship state#36SutuSebastian merged 3 commits intomainfrom
Conversation
fallow.md gains a "Status snapshot (as of 2026-05-01)" section that tabulates every adoption candidate's ship status — single source of truth for "what's open" without munging the original tier tables. Captures: - Tier A all shipped (PR #26) - B.5 partial (v1 in PR #33; --base <ref> + verdict deferred to v1.x) - B.6 shipped (PR #30) — table-in-DB, not parallel JSON files - B.7 shipped (PR #28) — landed on `symbols`, not `exports` - B.8 / C.9 / C.10 / C.11 / D.* still as-was - MCP server (agent-transports v1) shipped in PR #35 (adjacent — not a numbered fallow candidate but worth surfacing here) § 6 open questions: marks the 2 settled ones (actions ownership, audit verdict default) with their resolution PRs; preserves the 2 still-open ones (coverage column shape, plugin layer scope). § 3 already-shipped block: updates the visibility-tags note to acknowledge B.7 promoted it from regex to structured column instead of saying "B.7 proposes promoting" (which it doesn't anymore). competitive-scan-2026-04.md § 4: marks MCP server wrapping `query` as ✅ shipped via PR #35 with a cross-link to fallow.md's status snapshot. Other items still tracked there. No behavior change; pure docs refresh to match current reality.
|
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughUpdates to research documentation reflecting post-scan status, including a timestamped adoption-candidate matrix snapshot, shipped feature tracking with PR links, and clarifications on backlog items. The roadmap section now explicitly distinguishes shipped features (codemap mcp, agent-transports v1) from deferred items. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 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. Review rate limit: 0/1 reviews remaining, refill in 52 minutes and 42 seconds.Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/research/fallow.md (1)
69-76:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winMake terminology consistent: use
symbols.visibility, notexports.visibility.In the Tier B table, B.7 is titled as “structured
exports.visibilitycolumn” (Line 75), but the status snapshot + shipped notes say the column landed onsymbols(e.g., Line 22 and the §3 shipped bullet on Line 116). Aligning the wording avoids confusion when readers look up the actual schema/queries.✅ Suggested fix
-| B | B.7 | JSDoc visibility extracted as structured `exports.visibility` column | Already partially shipped: PR `#23`'s `visibility-tags` recipe parses `@public` / `@internal` / `@beta` / `@alpha` / `@private` from `doc_comment`. Promote the parser output into a real column on `exports` (or `symbols`) so queries like `WHERE visibility = 'beta'` don't need a `LIKE '%@beta%'` regex. Schema bump — counts as a minor per `.agents/lessons.md` "changesets bump policy". | Removes the two-step recipe (parse + filter) that the current setup forces. Aligns Codemap's surface with fallow's first-class JSDoc handling without copying fallow's rule machinery. | +| B | B.7 | JSDoc visibility extracted as structured `symbols.visibility` column | Already partially shipped: PR `#23`'s `visibility-tags` recipe parses `@public` / `@internal` / `@beta` / `@alpha` / `@private` from `doc_comment`. Promote the parser output into a real `symbols.visibility` column so queries like `WHERE visibility = 'beta'` don't need a `LIKE '%@beta%'` regex. Schema bump — counts as a minor per `.agents/lessons.md` "changesets bump policy". | Removes the two-step recipe (parse + filter) that the current setup forces. Aligns Codemap's surface with fallow's first-class JSDoc handling without copying fallow's rule machinery. |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/research/fallow.md` around lines 69 - 76, The Tier B table uses inconsistent terminology: change the B.7 title and any mentions of "exports.visibility" to "symbols.visibility" so it matches the actual shipped schema; specifically update the B.7 row title ("JSDoc visibility extracted as structured exports.visibility column") and any descriptive text in that row that references exports.visibility to instead reference symbols.visibility, and verify the rest of the document (e.g., the §3 shipped bullet and status notes) use the same "symbols.visibility" identifier.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/research/fallow.md`:
- Around line 10-28: The table has a malformed row around the "B | B.5" entry
that yields only 4 cells; open the row that starts with "B | B.5 | `codemap
audit` (structural-drift)" and ensure it contains five pipe-separated columns
(Tier, #, Item, Status, Where it landed / why deferred), moving the long
descriptive text into the fifth column and escaping any literal pipe characters
(or wrap them in backticks) so they don't split the row; after editing verify
the row now has four internal '|' separators and renders as a single table row.
---
Outside diff comments:
In `@docs/research/fallow.md`:
- Around line 69-76: The Tier B table uses inconsistent terminology: change the
B.7 title and any mentions of "exports.visibility" to "symbols.visibility" so it
matches the actual shipped schema; specifically update the B.7 row title ("JSDoc
visibility extracted as structured exports.visibility column") and any
descriptive text in that row that references exports.visibility to instead
reference symbols.visibility, and verify the rest of the document (e.g., the §3
shipped bullet and status notes) use the same "symbols.visibility" identifier.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: c37fc2e2-dd09-4a45-b962-4d5d429fd184
📒 Files selected for processing (2)
docs/research/competitive-scan-2026-04.mddocs/research/fallow.md
…cells, header was 5 CodeRabbit caught: status-snapshot table header has 5 columns (Tier / # / Item / Status / Where) but the D.12-D.16 row only had 4 (collapsed Status + Where into one cell). Markdown parses that as a malformed table; renderers either drop the row or misalign neighbouring rows. Added the missing 5th cell pointing back at § 1's Defer / skip table for the per-row reasoning.
…isibility) CodeRabbit caught: Tier B table B.7 row title still said 'exports.visibility column' despite the body hedging '(or symbols)' AND the shipped column landing on symbols. Status snapshot row at L22 already says symbols. Updated the title to match shipped reality + added an explicit nod to the original hedge so the historical-record property survives.
|
@coderabbitai the outside-diff finding on |
|
Tip For best results, initiate chat on the files or code changes.
If you found this review helpful, would you consider giving us a shout-out on X? Thank you for using CodeRabbit! |
Summary
Refreshes
docs/research/fallow.mdanddocs/research/competitive-scan-2026-04.mdagainst the current ship state — pure docs, no behavior change.The recent shipping cadence (PRs #26 / #28 / #30 / #33 / #35) closed most of the Tier A and Tier B candidates, but the research docs still read as if everything were open. Without a refresh, anyone reading the tracker thinks the same item is unshipped + needs a plan, which already burned time once this session.
What changed
fallow.md:actionsownership = recipe-defined; audit verdict default = defer + raw deltas +jq) with their resolution PRs.competitive-scan-2026-04.md:Why a snapshot section instead of munging each tier row
Test plan
bun run checkgreen (pure docs).agents/+templates/agents/mirror needed per Rule 10)Summary by CodeRabbit