Repository navigation
DOC-6154 Augment-friendly features in the repo for doc tasks - #2627
Merged
Merged
Conversation
Contributor
dwdougherty
approved these changes
Jan 13, 2026
dwdougherty
left a comment
Collaborator
There was a problem hiding this comment.
I just quickly scanned these since they're not really production docs. Approved.
Contributor
Author
|
@dwdougherty Yeah, there's nothing in there that worthwhile for a human to read. Anyway, thanks for the review :-) |
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.
For a little while now, we've had some Markdown files that contain docs to help AI to perform particular tasks (eg, how to modify the code example system or write/modify examples, etc). They are getting quite good now, but there is still the issue that Augment doesn't always attempt to look for these docs in the first place!
To try to make this work better, this PR does two main things:
for-ais-only. (This started as a James Bond pun but by chance, it happens to be quite good at piquing the interest of Augment, if it happens to notice the folder.)AI_AGENT_DEVELOPER_GUIDE.md. This contains a decision tree that helps to route Augment to the right docs quickly.Augment still doesn't necessarily spot either of these automatically but you can, at least, add "consult
AI_AGENT_DEVELOPER_GUIDE.mdfor guidance" to a prompt to give it a good start. I thinkAI_AGENT_DEVELOPER_GUIDE.mdwill need more work to make it really effective but for now, it's an extra option you can try if you are struggling to get a good result from Augment. It has been pretty effective for a recent task of adding descriptions to code examples (works much better and faster with the decision tree than without), so hopefully it's a step in the right direction.