Skip to content

chore(templates): add llms.txt docs banner to generated starters - #1295

Merged
leifermendez merged 2 commits into
builderbotfrom
chore/templates-llms-banner
Nov 18, 2026
Merged

leifermendez merged 2 commits into
builderbotfrom
chore/templates-llms-banner

Conversation

@leifermendez

Copy link
Copy Markdown
Member

Que tipo de Pull Request es?

  • Mejoras
  • Bug
  • Docs / tests

Descripción

Los proyectos que genera create-builderbot ahora abren su entrypoint (src/app.js / src/app.ts) con un comentario de 5 líneas que apunta a https://www.builderbot.app/llms.txt y le pide a un agente de IA leer esa documentación antes de responder o modificar el proyecto (API actual, patrones de uso, soluciones y buenas prácticas).

El banner vive en la fuente del generador y se propaga solo: starters/apps/** es generado, nunca editado a mano.

Cambios

Archivo Cambio
scripts/generate/template/js/src/app.js Banner de docs en las primeras 5 líneas
scripts/generate/template/ts/src/app.ts Ídem para TypeScript
starters/apps/*/src/app.{js,ts} Regenerados con pnpm run generate.templates: 181 archivos, +5 líneas cada uno
packages/cli/_test_/starters-banner.test.ts Test uvu nuevo (3 casos) que fija el banner en las 2 fuentes y en los 181 starters

Verificación ejecutada

Check Resultado
pnpm run generate.templates (2 corridas) 181 starters, git status limpio → idempotente y byte-idéntico a lo commiteado
pnpm run generate:check ✔ starters/apps is in sync with scripts/generate.
RED del test nuevo Quitando el banner de starters/apps/base-ts-tiktok-json/src/app.ts, el test falla nombrando ese starter
GREEN del test nuevo pnpm --filter @builderbot/cli test → 16/16 (3 casos nuevos)
Suite completa pnpm test → passed (30 proyectos)

Notas

  • Sin cambios de comportamiento: el diff son solo líneas de comentario agregadas en la cabecera, ningún import ni código tocado (verificado con git show --unified=0).
  • 36 entrypoints (tiktok, voice-whatsapp, meta-voice-ai × JS/TS) pasan por la rama del generador que elimina import { join } from 'path'; el banner sobrevive y los imports arrancan en la línea 6.
  • generate:check solo detecta drift template → starters, así que el test nuevo cubre el caso que ese guard no ve: el banner borrado de ambos lados a la vez.
  • El repo no tiene labels type:* disponibles; no agrego label.

Forma parte de este proyecto.

Point AI agents to https://www.builderbot.app/llms.txt in the first lines of
every generated src/app.{js,ts}, then regenerate starters/apps.
Pin the docs banner in the template sources and in every generated
starters/apps entrypoint. generate:check only catches drift between the
template and starters/apps, so it stays green when the banner disappears
from both sides.
@leifermendez
leifermendez merged commit 72e9845 into builderbot Nov 18, 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.

1 participant