docs: Document Flash AI coding agent integration#641
Conversation
Document the new flash rules command and AI coding agent integration feature that helps AI assistants work with Flash correctly by generating context files (CLAUDE.md, AGENTS.md, etc.). - Add flash/cli/rules.mdx documenting the new command - Update init.mdx with --no-rules flag and generated agent files - Update overview.mdx to include rules in command table - Update quickstart.mdx to note built-in agent integration - Add rules page to docs.json navigation
The original suggestion documented features that were removed before merge. This commit corrects the docs to reflect the actual behavior: - Remove `flash rules` CLI page (command does not exist) - Remove `--no-rules` flag from `flash init` docs (flag does not exist) - Update `flash init` to show only the files actually created: - `AGENTS.md` (if absent) - `CLAUDE.md` symlink (if absent) - Remove references to `.cursorrules`, `.github/copilot-instructions.md`, `.flash/context.md`, and the marker system (not created by flash init) - Add instructions for existing projects and opt-out - Update quickstart tip to reflect actual behavior
![promptless[bot]](https://avatars.githubusercontent.com/in/979718?s=60&v=4){kind=small}
There was a problem hiding this comment.
(Line 41)
Added --no-rules flag and AI coding agent files section based on PR #341. The flash init command now generates agent context files by default, with opt-out via --no-rules or per-file <!-- FLASH:DISABLE --> markers.
Source: runpod/flash#341
| ### AI coding agent files | ||
|
|
||
| Flash generates context files that help AI coding assistants (Claude Code, Cursor, GitHub Copilot, Codex, Aider, and others) use Flash correctly. These files tell agents to use Flash CLI commands instead of raw Runpod API calls. | ||
|
|
There was a problem hiding this comment.
Corrected the AI agent files section based on the final merged state of PR #341. The merged PR creates only AGENTS.md and CLAUDE.md (symlink) — the original suggestion documented features (.cursorrules, .github/copilot-instructions.md, .flash/context.md, flash rules command, --no-rules flag, marker system) that were removed before merge.
Source: runpod/flash#341
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Open this suggestion in Promptless to view citations and reasoning process
Update documentation for Flash AI coding agent files introduced in PR #341. Documents that
flash initnow createsAGENTS.md(CLI-first rules for AI coding tools) andCLAUDE.md(symlink) when absent. Includes instructions for existing projects and opt-out.Trigger Events
Tip: Use Slack message actions (⋯ menu → Update Docs) to capture doc updates without interrupting conversations 💬