Skip to content

feat: embed Markdown User Guide and AGENTS.md in agent-facing distributions - #10638

Open
osvaldomcc wants to merge 2 commits into
codeigniter4:4.8from
osvaldomcc:feat/distribute-agent-docs
Open

osvaldomcc wants to merge 2 commits into
codeigniter4:4.8from
osvaldomcc:feat/distribute-agent-docs

Conversation

@osvaldomcc

Copy link
Copy Markdown

Description

  • Add a job step to the framework distribution workflow that builds the User Guide as Markdown with sphinx-markdown-builder and embeds it into system/Docs, so coding agents get version-matched documentation alongside the distributed framework.
  • Ship �dmin/framework/AGENTS.md to the appstarter repository root on release, pointing agents to the embedded docs.

No framework runtime code is touched; changes are limited to GitHub Actions workflow, the deploy script, and Sphinx build requirements.

Checklist:

  • Securely signed commits
  • Component(s) with PHPDoc blocks, only if necessary or adds value (without duplication) — no PHP code changed
  • Unit testing, with >80% coverage — no PHP code changed; covered by the workflow's est -f ./source/system/Docs/index.md verification step
  • User guide updated — no public API/behavior change; CI and release tooling only
  • Conforms to style guide

@carson-codeigniter4 carson-codeigniter4 Bot added 4.8 PRs that target the `4.8` branch. github_actions Pull requests that update Github_actions code labels Oct 15, 2026

@michalsn michalsn left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR. I don't see a clear benefit to shipping the entire User Guide with every framework installation. Could you clarify:

  • How much does this increase the package and download size?
  • Why convert to Markdown instead of distributing the existing RST sources?
  • What concrete problem does this solve for coding agents?

My take is that AGENTS.md shouldn't be included in every appstarter project. Application owners should decide which instructions apply to agents working on their projects.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

4.8 PRs that target the `4.8` branch. github_actions Pull requests that update Github_actions code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants