Skip to content

doc: Add AGENTS.md (and CLAUDE.md) to guide AI agents working in LiteSATA - #52

Merged
enjoy-digital merged 1 commit into
masterfrom
doc/agents-md
Nov 2, 2026
Merged

enjoy-digital merged 1 commit into
masterfrom
doc/agents-md

Conversation

@enjoy-digital

Copy link
Copy Markdown
Owner

Adds a short AGENTS.md (read by Codex, Cursor, Copilot, Gemini...) and a one-line CLAUDE.md (@AGENTS.md, for Claude Code), like the ones merged in LiteX, LiteX-Boards, LiteDRAM, LiteEth, LitePCIe and LiteScope:

  • where things are in LiteSATA;
  • the commands that verify a change (the ones CI runs; test collection checked);
  • known pitfalls of LiteSATA (from past bring-ups and reviews);
  • the rules: coding style, never edit generated files, one topic per PR with what ran on which hardware and a note that an agent wrote it, never flash a board unasked;
  • pointers to the LiteX agent page, the debug method page (Debug-A-SoC-On-Hardware) and litex_mcp.

Documentation only.

Written by an AI agent (Claude Code), supervised by Florent Kermarrec.

🤖 Generated with Claude Code

…SATA.

Same as the other LiteX ecosystem repositories: where things are, the commands that verify a
change (the ones CI runs), the known pitfalls of LiteSATA, the rules, and pointers to the LiteX agent
page, the debug method page and litex_mcp. CLAUDE.md imports AGENTS.md for Claude Code.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@enjoy-digital
enjoy-digital merged commit e3c4f6e into master Nov 2, 2026
4 checks passed
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