Skip to content

docs(research): refresh fallow.md + scan against current ship state#36

Merged
SutuSebastian merged 3 commits intomainfrom
docs/refresh-research-status
May 1, 2026
Merged

docs(research): refresh fallow.md + scan against current ship state#36
SutuSebastian merged 3 commits intomainfrom
docs/refresh-research-status

Conversation

@SutuSebastian
Copy link
Copy Markdown
Contributor

@SutuSebastian SutuSebastian commented May 1, 2026

Summary

Refreshes docs/research/fallow.md and docs/research/competitive-scan-2026-04.md against 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:

  • Adds a Status snapshot (as of 2026-05-01) section right after § 0 — tabulates every A/B/C/D candidate with ✅ Shipped / ⚠️ Partial / ❌ Open / ⏸️ Skip plus the PR or trigger.
  • Surfaces the MCP server (agent-transports v1, PR feat(mcp): codemap mcp — agent-transports v1 (Tracer 1 of 7) #35) as adjacent-but-shipped (not a numbered fallow candidate but worth tracking).
  • Marks the two settled § 6 open questions (actions ownership = recipe-defined; audit verdict default = defer + raw deltas + jq) with their resolution PRs.
  • Updates the § 3 already-shipped block: visibility-tags now correctly says B.7 did promote to a structured column instead of proposes promoting.

competitive-scan-2026-04.md:

Why a snapshot section instead of munging each tier row

  • Preserves the original assessment as a stable record (the tier tables tell a story about why each item was Tier A/B/C at the time).
  • Keeps "what's open" as a single read-once table instead of N inline status badges to sync.
  • Matches the "ongoing tracker" framing in the doc's intro.

Test plan

Summary by CodeRabbit

  • Documentation
    • Updated roadmap documentation reflecting shipped features (codemap mcp, agent-transports) and current development status.
    • Added comprehensive feature adoption status snapshot documenting shipped, partial, and deferred items.

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.
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 1, 2026

⚠️ No Changeset found

Latest commit: d21483a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 1, 2026

Warning

Rate limit exceeded

@SutuSebastian has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 52 minutes and 42 seconds before requesting another review.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: eca6cd1b-01a1-4d84-8265-0befa94dd625

📥 Commits

Reviewing files that changed from the base of the PR and between 7893f88 and d21483a.

📒 Files selected for processing (1)
  • docs/research/fallow.md
📝 Walkthrough

Walkthrough

Updates 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

Cohort / File(s) Summary
Research documentation status updates
docs/research/competitive-scan-2026-04.md, docs/research/fallow.md
Roadmap rewrite to link shipped items to PRs; fallow.md expanded with timestamped adoption matrix snapshot (tiers A–D), including shipped items A.1–A.4, B.6–B.7, partial B.5 state, and deferred work; visibility-tags column updated to symbols.visibility with query logic changed from regex LIKE to WHERE visibility IS NOT NULL.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 The roadmap now shines so clear and bright,
With shipped features linked just right,
Codemap mcp hops across the fallow ground,
Status snapshots captured, progress found! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main changes: refreshing fallow.md and updating the competitive scan against current shipped state.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/refresh-research-status

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.

❤️ Share
Review rate limit: 0/1 reviews remaining, refill in 52 minutes and 42 seconds.

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 win

Make terminology consistent: use symbols.visibility, not exports.visibility.

In the Tier B table, B.7 is titled as “structured exports.visibility column” (Line 75), but the status snapshot + shipped notes say the column landed on symbols (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

📥 Commits

Reviewing files that changed from the base of the PR and between 119db38 and 7893f88.

📒 Files selected for processing (2)
  • docs/research/competitive-scan-2026-04.md
  • docs/research/fallow.md

Comment thread docs/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.
@SutuSebastian
Copy link
Copy Markdown
Contributor Author

@coderabbitai the outside-diff finding on docs/research/fallow.md L75 is fixed in d21483a — aligned the Tier B B.7 row title to symbols.visibility (matching the shipped column, the L22 status snapshot, and the body's own "(or symbols)" hedge). Added an explicit nod to the original hedge so the historical record of the original proposal still reads cleanly.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 1, 2026

Tip

For best results, initiate chat on the files or code changes.

@SutuSebastian: Thanks for the follow-up! The fix in d21483a looks clean — aligning the B.7 row title to symbols.visibility ensures consistency across the status snapshot (L22), the shipped column name, and the body text, while the explicit nod to the original hedge keeps the proposal's historical context intact. All good here!


If you found this review helpful, would you consider giving us a shout-out on X?

Thank you for using CodeRabbit!

@SutuSebastian SutuSebastian merged commit bb59905 into main May 1, 2026
9 checks passed
@SutuSebastian SutuSebastian deleted the docs/refresh-research-status branch May 1, 2026 15:50
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