Add AI agent guidance, architecture docs, and project skills#7550
Open
The-E wants to merge 5 commits into
Open
Add AI agent guidance, architecture docs, and project skills#7550The-E wants to merge 5 commits into
The-E wants to merge 5 commits into
Conversation
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
1 participant
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.
Summary
This branch is documentation-only — it adds onboarding/guidance material for AI coding agents (and humans) working in the FSO tree. No engine code is touched; all 60 changed files are new Markdown (+2,673 lines).
What's included
Top-level & per-module agent guidance
• AGENTS.md — entry-point guide for agents: project overview, repo layout, build/test/style conventions, and pointers into the docs.
• Per-module AGENTS.md stubs across code/* (ai, cfile, cmdline, globalincs, graphics, hud, io, lab, localization, menuui, mission, mod_table, model, network, object, options, parse, physics, scripting, ship, sound, ui, weapon) plus fred2/ and qtfred/.
Architecture & module documentation
• documentation/ARCHITECTURE.md — high-level map of the engine's subsystems and where concepts live.
• documentation/modules/*.md — per-module entry-point guides (~25 modules) so agents can navigate without blind grepping.
Cursor project skills (.cursor/skills/)
• FSO-specific workflow skills: fso-add-table-field, fso-add-sexp, fso-add-lua-api, fso-add-object-type, fso-add-hud-gauge, fso-build-and-test, each encoding the exact files to touch and how to verify.
• thermo-nuclear-code-quality-review — an opt-in, strict maintainability/abstraction review skill (explicit invocation only).
• README.md indexing the available skills and authoring conventions.
Why
FSO is a large, legacy-heavy, cross-platform C++ codebase. These docs give agents (and new contributors) a navigable map of subsystems, the project's build/style conventions, and repeatable, FSO-correct workflows for
common engine extensions — reducing blind exploration and convention mistakes.