-
Notifications
You must be signed in to change notification settings - Fork 81
chore: standardize module examples to use coder_agent.main
#566
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
also, do we want linting rules for this as well? |
Update all module README files to use coder_agent.main instead of coder_agent.example for consistency with existing template conventions. Changes: - Updated 50+ module README.md files - Updated root README.md and CONTRIBUTING.md - Updated examples/templates/main.tf This ensures copy-paste examples from module docs work seamlessly with the majority of templates that use "main" as the agent name.
710b6a9 to
b427fe3
Compare
coder_agent.main
If its not a huge task to add it wouldn't be a bad idea. |
|
@phorcys420 one thing we need to consider here is that none of these changes will reflect on the registry unless we are actually bumping the version of every single module we updated. |
Add a simple bash script that validates module documentation uses coder_agent.main consistently. This can be integrated into CI to prevent future inconsistencies. The script checks: - Module README files use coder_agent.main - Example templates use coder_agent.main - Root documentation uses coder_agent.main Usage: ./scripts/lint-agent-names.sh
|
I should add that if you wanted to just do a patch version bump we could just run the version bump script with the patch flag and it should automatically update all the versions so we can do releases for this easily |
|
@DevelopmentCats yeah, i can bump, i'll do another PR myself instead cause blink is going crazy rn, sorry for the noise haha |
Summary
This PR standardizes all module documentation examples to use
coder_agent.maininstead ofcoder_agent.example, aligning with the most common template convention.Problem
Currently, there's an inconsistency between template definitions and module documentation:
"main"as the agent name"example"as a placeholder, which doesn't exist in any templates, except some modules who already use "main"This creates friction when users copy examples from module docs into their templates that use
mainas the agent name.Solution
Update all module documentation to use
coder_agent.mainsince:Changes
Module Documentation (52 files)
coder_agent.example→coder_agent.mainREADME.mdCONTRIBUTING.mdexamples/templates/main.tfWhat's NOT in this PR
❌ Template changes - Templates are left as-is to avoid breaking existing workspaces
❌ Linting rules - Will be addressed separately if desired
Impact
✅ Zero breaking changes: Only documentation is updated
✅ Better DX: Copy-paste examples work with 78% of existing templates
✅ Consistency: Documentation now matches the de facto standard
Testing
git diffRelated
This addresses the documentation inconsistency identified in the registry audit. Template standardization can be addressed in a future PR if desired.
PR by @phorcys420