Skip to content

Flatten README template list for agent discoverability#86

Merged
shrey150 merged 6 commits intodevfrom
shrey/flatten-readme-template-list
Apr 16, 2026
Merged

Flatten README template list for agent discoverability#86
shrey150 merged 6 commits intodevfrom
shrey/flatten-readme-template-list

Conversation

@shrey150
Copy link
Copy Markdown
Contributor

@shrey150 shrey150 commented Apr 7, 2026

Summary

  • Replaces the generic README with a flat, searchable table of all 80+ templates
  • Each row includes template name (linked), language (TS/PY/GO), and a one-line description
  • Preserves Model Gateway, Getting Started, Resources, Contributing, and License sections
  • Removes emojis from section headers

Test plan

  • Verify table renders correctly on GitHub
  • Confirm all template links resolve to valid directories

Note

Low Risk
Low risk: changes are limited to documentation and CI validation, with no runtime/product code impact aside from potentially failing PRs when the README index is out of sync.

Overview
Replaces the top-level README.md overview with a single alphabetized table of all templates linking to their TypeScript/Python/Go directories, and tidies section headings/content around Model Gateway and Getting Started.

Adds an automated README template index validator (scripts/check-readme-template-index.mjs) plus a GitHub Action workflow and a npm run check:readme-template-index step wired into npm run check, ensuring the README table stays consistent with the repo’s first-level template directories (order, link format, duplicates, missing/extra entries).

Reviewed by Cursor Bugbot for commit d7c2566. Bugbot is set up for automated code reviews on this repo. Configure here.

shrey150 and others added 5 commits April 7, 2026 09:32
Add a single searchable table of all 80+ templates with name, language,
and one-line description so agents and humans can quickly find relevant
templates without navigating subdirectories.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Comment thread README.md Outdated
@shrey150 shrey150 merged commit 40fd619 into dev Apr 16, 2026
2 checks passed
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