Skip to content

Make the AI-agent setup guide discoverable from the README#282

Closed
kamran-rapidfireAI wants to merge 1 commit into
mainfrom
docs/readme-agent-disclosure
Closed

Make the AI-agent setup guide discoverable from the README#282
kamran-rapidfireAI wants to merge 1 commit into
mainfrom
docs/readme-agent-disclosure

Conversation

@kamran-rapidfireAI

@kamran-rapidfireAI kamran-rapidfireAI commented Jun 25, 2026

Copy link
Copy Markdown
Collaborator

Why

When a user asks an AI coding agent (Claude Code, Cursor, Codex, GitHub Copilot, Windsurf, Aider, Junie, …) to install or set up rapidfireai, the agent's first stop is the README — it's the canonical entry point on GitHub and PyPI. We now ship an operational, agent-oriented setup guide at docs/AGENTS.md (#281), but nothing in the README points to it. So an agent has no way to discover the guide and will improvise the install (wrong init variant, missing port-forward, skipped HF auth, …) instead of following it.

This PR adds the missing discovery hook: a short notice near the top of the README that routes any AI coding agent to docs/AGENTS.md before it starts. Without it, the guide exists but effectively never gets read. (The PyPI AI-Agent-Guide URL added in #281 covers discovery from PyPI; this covers the GitHub README.)

What

A collapsible <details> block placed just above ## Overview — high enough that an agent sees it early. It:

  • points agents to the operational setup guide (docs/AGENTS.md) with blob + raw links,
  • gives a one-line RAG-vs-fine-tuning decision so the agent picks the right path immediately,
  • redirects contributors to the root AGENTS.md / CONTRIBUTING.md instead.

Collapsed by default, so it adds near-zero noise for human readers while staying machine-discoverable.

Files (1)

  • README.md

Dependencies

Independent of the other PRs at the file level. The block links to docs/AGENTS.md and root AGENTS.md via absolute blob/main/... URLs, which resolve once #280 and #281 are merged. To avoid a transient 404 window on main, prefer to merge this last (after #280 and #281).

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only README change with no runtime, security, or application code impact; linked paths may 404 on main until related docs PRs merge.

Overview
Adds a collapsible AI coding agent section to README.md immediately above Overview, so agents helping users install or set up rapidfireai are directed to docs/AGENTS.md first (with blob/raw GitHub links).

The block includes a one-line RAG vs fine-tuning path (rapidfireai init + mode="evals" vs init --train + mode="fit") and clarifies that contributors working on the repo should use root AGENTS.md and CONTRIBUTING.md instead.

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

Add a collapsible notice above the Overview that points AI coding agents to the
operational setup guide (docs/AGENTS.md) before they help a user install or set
up rapidfireai, with a quick RAG-vs-fine-tuning decision and a pointer to the
contributor docs.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@kamran-rapidfireAI kamran-rapidfireAI force-pushed the docs/readme-agent-disclosure branch from 3ecc693 to f3e9fcc Compare June 26, 2026 00:22
@kamran-rapidfireAI kamran-rapidfireAI changed the title Add AI coding agent notice to README Make the AI-agent setup guide discoverable from the README Jun 26, 2026

@david-rfai david-rfai left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Since this requires PR #280, please consolidate this with #280

@kamran-rapidfireAI

Copy link
Copy Markdown
Collaborator Author

Consolidated into #281 — the README discovery notice now ships in the same PR as the docs/AGENTS.md guide it points to, so the notice and its target land atomically (no dangling link, single reviewable diff).

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.

2 participants