Repository navigation
feat: embed Markdown User Guide and AGENTS.md in agent-facing distributions - #10638
Open
osvaldomcc wants to merge 2 commits into
Open
osvaldomcc wants to merge 2 commits into
osvaldomcc wants to merge 2 commits into
Conversation
michalsn
reviewed
Oct 18, 2026
michalsn
left a comment
Member
There was a problem hiding this comment.
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
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
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.
Description
No framework runtime code is touched; changes are limited to GitHub Actions workflow, the deploy script, and Sphinx build requirements.
Checklist: