docs: add README_FOR_AGENTS.md for LLM agent usage guide#1025
Merged
Conversation
Add an agent-optimized installation and usage guide (README_FOR_AGENTS.md) with accurate configuration examples based on the actual shake.toml, links to official docs and releases. Update README.md with "For Humans" / "For LLM Agents" sections following the oh-my-opencode pattern. 🤖 Generated with [Qoder][https://qoder.com]
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
1 participant
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.
Summary
README_FOR_AGENTS.md: a comprehensive, agent-optimized guide covering installation (binary/Docker/source), all reader/writer configurations with inline comments, filter/advanced options, practical examples, and known limitations.README.md: split "How to Get RedisShake" into "For Humans" and "For LLM Agents" subsections, following the oh-my-opencode pattern. The LLM Agents section provides a copy-paste prompt pointing toREADME_FOR_AGENTS.md.Test plan
README_FOR_AGENTS.mdrenders correctly on GitHubhttps://raw.githubusercontent.com/tair-opensource/RedisShake/v4/README_FOR_AGENTS.mdis accessible after merge🤖 Generated with [Qoder][https://qoder.com]