docs: emphasize coding agent friendly design across documentation#26
Merged
Conversation
- Update README tagline to "Coding Agent friendly tool to magically generate text and images" - Add Agent-Friendly Design section to README highlighting key features - Add coding-agent-design.md spec documenting design principles for agent compatibility - Update AGENTS.md top-level requirements to reflect agent-friendly mission - Update docs/index.md to reference all specs
- Update prompts/trickery_readme.md with agent-friendly messaging - Add pre-PR checklist item: regenerate README from template
chaliy
force-pushed
the
claude/update-ai-generation-tools-JUgLC
branch
from
5d339aa to
810f812
Compare
chaliy
force-pushed
the
claude/update-ai-generation-tools-JUgLC
branch
from
810f812 to
e12c8a5
Compare
chaliy
added a commit
that referenced
this pull request
May 30, 2026
## Summary - Update README tagline to "Coding Agent friendly tool to magically generate text and images" - Add CI, crates.io, and coding agent friendly badges - Add new `specs/coding-agent-design.md` documenting agent-friendly design principles - Update AGENTS.md top-level requirements and pre-PR checklist ## What This PR aligns documentation with the project's mission as a coding agent friendly tool by: - Renaming from "Magic tool to generate things" to "Trickery" with clear agent-friendly messaging - Adding "Agent-Friendly Design" section highlighting key features (error recovery, help system, JSON output) - Creating spec documenting why design choices matter for agents (discoverability, error recovery, predictable behavior) - Adding pre-PR requirement to update README via prompt template ## Why The tool already has excellent agent-friendly features (rich error messages, full help, JSON output), but documentation didn't communicate this clearly. ## How Documentation-only changes across README, AGENTS.md, docs/index.md, and new spec file. ## Risk - Low - Documentation only, no code changes ### Checklist - [x] Unit tests are passed - [x] Smoke tests are passed - [x] Documentation is updated --------- Co-authored-by: Claude <noreply@anthropic.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
2 participants
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
specs/coding-agent-design.mddocumenting agent-friendly design principlesWhat
This PR aligns documentation with the project's mission as a coding agent friendly tool by:
Why
The tool already has excellent agent-friendly features (rich error messages, full help, JSON output), but documentation didn't communicate this clearly.
How
Documentation-only changes across README, AGENTS.md, docs/index.md, and new spec file.
Risk
Checklist