Skip to content

Conversation

@edenreich
Copy link
Contributor

Summary

This PR improves the documentation templates with better wording and formatting:

  • Changed "Production ready" to "Enterprise-ready" in README.md.tmpl - Better positioning and consistent with industry terminology
  • Added missing health check endpoint to AGENTS.md.tmpl - Completes the API endpoints documentation to match the ADK server implementation
  • Fixed spacing in Parameters column - Added proper spaces before/after parameter lists in Skills table for better readability

Changes

README.md.tmpl

  • Line 60: Production readyEnterprise-ready
  • Line 74: Added spaces around parameter list output for proper markdown table formatting

AGENTS.md.tmpl

  • Line 104: Added GET /health endpoint to API documentation

Testing

  • Built ADL CLI with task build
  • Generated test project from examples/go-agent.yaml to test-output
  • Verified all template changes render correctly:
    • ✅ "Enterprise-ready" appears in features list
    • ✅ Health check endpoint listed in both README.md and AGENTS.md
    • ✅ Parameters column has proper spacing in Skills table

Motivation

These changes ensure generated documentation is accurate, professional, and matches the actual A2A protocol implementation in the ADK.

🤖 Generated with Claude Code

- Change "Production ready" to "Enterprise-ready" in README.md.tmpl for better positioning
- Add missing health check endpoint to AGENTS.md.tmpl API endpoints section
- Fix missing spaces in Parameters column of Skills table in README.md.tmpl

These changes improve documentation accuracy and formatting consistency across generated projects.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@edenreich edenreich changed the title fix(templates): improve documentation wording and formatting fix(templates): Improve documentation wording and formatting Nov 14, 2025
@edenreich edenreich merged commit 999d95b into main Nov 14, 2025
1 check passed
@edenreich edenreich deleted the fix/improve-template-wording-and-formatting branch November 14, 2025 14:25
ig-semantic-release-bot bot added a commit that referenced this pull request Nov 14, 2025
## [0.24.2](v0.24.1...v0.24.2) (2025-11-14)

### 🐛 Bug Fixes

* **templates:** improve documentation wording and formatting ([#91](#91)) ([999d95b](999d95b))
@ig-semantic-release-bot
Copy link
Contributor

🎉 This PR is included in version 0.24.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants