Make the AI-agent setup guide discoverable from the README#282
Closed
kamran-rapidfireAI wants to merge 1 commit into
Closed
Make the AI-agent setup guide discoverable from the README#282kamran-rapidfireAI wants to merge 1 commit into
kamran-rapidfireAI wants to merge 1 commit into
Conversation
10 tasks
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>
3ecc693 to
f3e9fcc
Compare
This was referenced Jun 26, 2026
david-rfai
reviewed
Jun 27, 2026
Collaborator
Author
|
Consolidated into #281 — the README discovery notice now ships in the same PR as the |
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
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.
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 atdocs/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 (wronginitvariant, 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.mdbefore it starts. Without it, the guide exists but effectively never gets read. (The PyPIAI-Agent-GuideURL 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:docs/AGENTS.md) with blob + raw links,AGENTS.md/CONTRIBUTING.mdinstead.Collapsed by default, so it adds near-zero noise for human readers while staying machine-discoverable.
Files (1)
README.mdDependencies
Independent of the other PRs at the file level. The block links to
docs/AGENTS.mdand rootAGENTS.mdvia absoluteblob/main/...URLs, which resolve once #280 and #281 are merged. To avoid a transient 404 window onmain, 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
mainuntil related docs PRs merge.Overview
Adds a collapsible AI coding agent section to
README.mdimmediately above Overview, so agents helping users install or set uprapidfireaiare directed todocs/AGENTS.mdfirst (with blob/raw GitHub links).The block includes a one-line RAG vs fine-tuning path (
rapidfireai init+mode="evals"vsinit --train+mode="fit") and clarifies that contributors working on the repo should use rootAGENTS.mdandCONTRIBUTING.mdinstead.Reviewed by Cursor Bugbot for commit f3e9fcc. Bugbot is set up for automated code reviews on this repo. Configure here.