Skip to content

Conversation

@blinkagent
Copy link
Contributor

@blinkagent blinkagent bot commented Nov 26, 2025

Summary

This PR standardizes all module documentation examples to use coder_agent.main instead of coder_agent.example, aligning with the most common template convention.

Problem

Currently, there's an inconsistency between template definitions and module documentation:

  • Templates: 78% (21 of 27) use "main" as the agent name
  • Module documentation: Most of examples use "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 main as the agent name.

Solution

Update all module documentation to use coder_agent.main since:

  1. It matches the most common convention (21 of 27 existing templates)
  2. Creates consistency between docs and real-world usage
  3. Reduces the need for users to edit copy-pasted examples

Changes

Module Documentation (52 files)

  • ✅ Updated 50+ module README.md files from coder_agent.examplecoder_agent.main
  • ✅ Updated root README.md
  • ✅ Updated CONTRIBUTING.md
  • ✅ Updated examples/templates/main.tf

What'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

  • ✅ All changes verified with git diff
  • ✅ Only modified documentation files (52 files changed)
  • ✅ 200 insertions, 200 deletions (pure substitution)

Related

This addresses the documentation inconsistency identified in the registry audit. Template standardization can be addressed in a future PR if desired.

PR by @phorcys420

@phorcys420 phorcys420 marked this pull request as draft November 26, 2025 18:12
@phorcys420 phorcys420 changed the title Standardize coder_agent resource name to "main" across templates and modules chore: standardize coder_agent resource name to "main" across templates and modules Nov 26, 2025
@phorcys420
Copy link
Member

also, do we want linting rules for this as well?

@coder coder deleted a comment from blinkagent bot Nov 26, 2025
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.
@blinkagent blinkagent bot force-pushed the standardize-agent-name-to-main branch from 710b6a9 to b427fe3 Compare November 26, 2025 18:56
@blinkagent blinkagent bot changed the title chore: standardize coder_agent resource name to "main" across templates and modules docs: Standardize module examples to use coder_agent.main Nov 26, 2025
@coder coder deleted a comment from blinkagent bot Nov 26, 2025
@phorcys420 phorcys420 marked this pull request as ready for review November 26, 2025 19:06
@phorcys420 phorcys420 changed the title docs: Standardize module examples to use coder_agent.main chore: standardize module examples to use coder_agent.main Nov 26, 2025
@DevelopmentCats
Copy link
Contributor

also, do we want linting rules for this as well?

If its not a huge task to add it wouldn't be a bad idea.

@DevelopmentCats
Copy link
Contributor

@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
@coder coder deleted a comment from blinkagent bot Nov 26, 2025
@phorcys420 phorcys420 marked this pull request as draft November 26, 2025 19:10
@DevelopmentCats
Copy link
Contributor

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

@phorcys420
Copy link
Member

@DevelopmentCats yeah, i can bump, i'll do another PR myself instead cause blink is going crazy rn, sorry for the noise haha

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants