docs: add agent development guide reference to README #333
Conversation
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
dhofheinz
requested review from
brandonkachen,
charleslien and
jahooma
as code owners
Addresses common Windows-specific issues reported in CodebuffAI#294, CodebuffAI#274, CodebuffAI#299: - Network/proxy configuration for version check failures - Git Bash/WSL recommendations for git command compatibility - Browser login workarounds for Git Bash users - Clarification on "Update available: error" message All solutions are configuration/workflow guidance with no code changes.
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.
Adds reference to the comprehensive agent development guide that
codebuff init-agentscreates.Changes
init-agentscommand explaining what gets created.agents/README.md, examples, types, etc.).agents/README.mdWhy
Users currently don't know that
init-agentscreates extensive documentation (1,493+ lines total across all files). This addition surfaces the comprehensive guide that already exists, improving discoverability without adding bloat to the main README.The template README contains detailed documentation on agent structure, available tools, testing workflows, publishing process, best practices, and advanced patterns - but users had no way to know it existed from reading the main README.