Repository navigation
feat: embed agent-ready docs and AGENTS.md in framework distributions - #10637
osvaldomcc wants to merge 2 commits into
Conversation
Add admin/framework/AGENTS.md so the framework distribution includes managed agent instructions pointing at system/Docs, and copy the same file into the appstarter root during deploy so both install channels (zip and Composer) get it.
Convert the Sphinx user guide to Markdown in the framework release job (excluding _static, changelogs and images) and embed it in system/Docs before the distribution is assembled, giving agents version-matched docs for both manual downloads and Composer installs.
|
Hi there, @osvaldomcc! 👋 It looks like this pull request does not follow our template:
Please update the description to follow the template. The Hi there, @osvaldomcc! 👋 Thank you for sending this PR! We expect the following in all Pull Requests (PRs).
Important We expect all code changes or bug-fixes to be accompanied by one or more tests added to our test suite to prove the code works. If pull requests do not comply with the above, they will likely be closed. Since we are a team of volunteers, we don't have any more time to work See https://github.com/codeigniter4/CodeIgniter4/blob/develop/contributing/pull_request.md |
Make the CodeIgniter 4 distribution friendlier to AI coding agents (Codex,
Claude Code, Cursor, Copilot, etc.) by shipping managed agent instructions and
version-matched documentation in the artifacts end users download, following
the same
AGENTS.mdconvention adopted by other frameworks.1. Ship
AGENTS.mdin both distributable reposadmin/framework/AGENTS.mdwith managed agent instructions that directagents to the bundled documentation (
system/Docsfor the frameworkdistribution,
vendor/codeigniter4/framework/system/Docsfor Composer /app starter installs).
.github/scripts/deploy-appstarterto copy the same canonical fileinto the app starter root, so a single source serves both install channels
(manual zip download and
composer create-project).2. Embed the user guide as Markdown in
system/Docsdeploy-distributables.ymlnow converts theSphinx user guide to Markdown with
sphinx-markdown-builderand embeds itinto
system/Docsbefore the distribution is assembled._static,changelogsandimagesare excluded from this build (theoutput is LLM-oriented); the HTML user guide build is unaffected since the
exclusions are passed only to the Markdown invocation via
-D.test -f system/Docs/index.mdguard fails the job if the conversionproduces no output, so a release can never ship without its embedded docs.
No framework runtime code is touched: no BC impact and nothing applicable for
PHP unit tests or PHPDoc (CI/distribution changes only). Docs ship inside the
release tag, so agents always get documentation matching the installed
framework version.