镜像站点 · 本页由第三方 GitHub 只读镜像提供,非 GitHub 官方站点,不接受任何登录或凭据输入。前往 github.com
Skip to content

DOC-6154 Augment-friendly features in the repo for doc tasks - #2627

Merged
andy-stark-redis merged 10 commits into
mainfrom
DOC-6154-augify-our-repo
Jan 13, 2026
Merged

andy-stark-redis merged 10 commits into
mainfrom
DOC-6154-augify-our-repo

Conversation

@andy-stark-redis

Copy link
Copy Markdown
Contributor

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:

  • Moves AI-specific docs to a main folder called 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.)
  • Adds a new file 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.md for guidance" to a prompt to give it a good start. I think AI_AGENT_DEVELOPER_GUIDE.md will 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.

@andy-stark-redis
andy-stark-redis requested a review from a team January 13, 2026 11:38
@andy-stark-redis andy-stark-redis self-assigned this Jan 13, 2026
@andy-stark-redis andy-stark-redis added the AI-friendliness Features that help AI tools understand and use the doc pages more easily. label Jan 13, 2026
@github-actions

github-actions Bot commented Jan 13, 2026 •

Copy link
Copy Markdown
Contributor

DOC-6154

@dwdougherty dwdougherty left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I just quickly scanned these since they're not really production docs. Approved.

@andy-stark-redis

Copy link
Copy Markdown
Contributor Author

@dwdougherty Yeah, there's nothing in there that worthwhile for a human to read. Anyway, thanks for the review :-)

@andy-stark-redis
andy-stark-redis merged commit a6432c2 into main Jan 13, 2026
6 of 10 checks passed
@andy-stark-redis
andy-stark-redis deleted the DOC-6154-augify-our-repo branch January 13, 2026 14:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AI-friendliness Features that help AI tools understand and use the doc pages more easily.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants