Skip to content

Refresh standing docs for health, owners, and contributor map - #161

Merged
kody-bot merged 2 commits into
mainfrom
cursor/docs-freshness-kentcdodds-mediarss-a3b0
Oct 31, 2026
Merged

kody-bot merged 2 commits into
mainfrom
cursor/docs-freshness-kentcdodds-mediarss-a3b0

Conversation

@kentcdodds

@kentcdodds kentcdodds commented Oct 31, 2026 •

Copy link
Copy Markdown
Owner

Intent

Bring standing docs in line with how MediaRSS works now: the /health snapshot, MCP transport, missing primitive owners, and a thinner AGENTS/README map that points at contributing.

Door: two-way

Cleanup: none

Why

A docs-freshness pass after #160. No product changelog language was left. Remaining drift was accuracy and duplication: AGENTS and README Development repeated the contributing gate; /health omitted OAuth; MEDIA_ANALYTICS_MAX_SQLITE_VARIABLE_NUMBER was only in primitives; throwaway test DBs were called empty files; primitives omitted app/assets.ts, format.ts, and the CSS token split; the Feature Map listed /mcp as POST-only.

Testing

  • npm run validate — format, lint, typecheck, 45 files / 306 tests (including Feature Map check). 3 pre-existing lint warnings, 0 errors.
  • Regenerated the Feature Map with npm run --silent control -- map --write.
  • Cross-checked claims against app/helpers/health.ts, app/routes/mcp/index.ts, app/mcp/cors.ts, app/db/index.ts, test/global-setup.ts, app/assets.ts, app/helpers/format.ts, app/assets/styles.css, app/routes/admin/api/media-analytics.$path.ts, and tools/control-mediarss.ts.

No runtime or UI behavior change. Could not verify in a browser because this is docs-only.

System recap

Risk: low Touches:

  • AGENTS.md, README.md, docs/contributing.md
  • docs/primitives.md, docs/mcp-server-best-practices.md
  • Control skill and Feature Map (tools/feature-notes.ts)

(extends)

  • AGENTS and README Development point at contributing for CI, hooks, and the data layer.
  • /health names MCP and OAuth; README lists MEDIA_ANALYTICS_MAX_SQLITE_VARIABLE_NUMBER.
  • Primitives name the asset server, format helpers, edit hrefs, and CSS variables.
  • Feature Map /mcp methods are GET, POST, OPTIONS; health note includes OAuth.
Open in Web Open in Cursor 

Note

Low Risk
Markdown and generated Feature Map notes only; no application code paths change.

Reviewed by Cursor Bugbot for commit 6659385. Bugbot is set up for automated code reviews on this repo. Configure here.

Summary by CodeRabbit

  • Documentation
    • Updated the documented browsing options to include headed mode and an output directory, and the published health-check options to include an image selection.
    • Clarified that the public health snapshot covers OAuth, and that the MCP route supports GET, POST, and OPTIONS.
    • Documented an optional setting to cap SQLite bind variables used for per-file analytics.
    • Streamlined development guidance and clarified database-testing setup and MCP server behavior.

cursoragent and others added 2 commits October 31, 2026 09:06
Keep the version pins and validate/check commands on the map pages; drop the
duplicated CI, hooks, command list, and data-layer walkthrough. Document the
/health snapshot and MEDIA_ANALYTICS_MAX_SQLITE_VARIABLE_NUMBER on the
operator README.

Co-authored-by: Kent C. Dodds <me+github@kentcdodds.com>
Name the asset server, format helpers, and CSS token files. Describe
throwaway test DBs as unmigrated WAL files. Record createMcpHandler
legacy: reject, /mcp GET+OPTIONS, and the remaining control CLI flags.

Co-authored-by: Kent C. Dodds <me+github@kentcdodds.com>
@coderabbitai

coderabbitai Bot commented Oct 31, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation updates describe CLI options, MCP and health endpoints, contributor and test-database guidance, an optional analytics setting, and UI and asset references.

Changes: Repository documentation refresh

Layer / File(s) Summary
Documented CLI and runtime contracts
.agents/skills/control-mediarss/SKILL.md, .agents/skills/control-mediarss/references/feature-map.md, docs/mcp-server-best-practices.md, README.md, tools/feature-notes.ts
Documents additional CLI options, MCP methods and transport behavior, and OAuth in the public health snapshot.
Contributor and analytics guidance
AGENTS.md, README.md, docs/contributing.md
Updates local development and test-database guidance. Documents the optional SQLite bind-variable limit for per-file analytics.
UI and assets reference
docs/primitives.md
Updates references for edit-route helpers, formatting, Remix assets, and style tokens.

Estimated code review effort: 2 (Simple) | ~12 minutes

Change: Other

Possibly related PRs

  • kentcdodds/mediarss#133: Introduced the control-mediarss skill, feature map, contributor guide, and primitives guide updated here.
  • kentcdodds/mediarss#134: Documents the MCP Streamable HTTP and OAuth contract extended by these documentation updates.
  • kentcdodds/mediarss#155: Defines CI and local-gate guidance in files updated by this pull request.
Merge Risk: Low · up to 66593

Correct the analytics setting description so operators understand what the limit applies to.

- [ ] Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@kody-bot
kody-bot merged commit 8f19b28 into main Oct 31, 2026
5 of 6 checks passed
@kody-bot
kody-bot deleted the cursor/docs-freshness-kentcdodds-mediarss-a3b0 branch October 31, 2026 09:11
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.

3 participants