Skip to content

docs: rewrite README post-facelift#64

Merged
Xiza73 merged 1 commit into
devfrom
docs/post-facelift
May 8, 2026
Merged

docs: rewrite README post-facelift#64
Xiza73 merged 1 commit into
devfrom
docs/post-facelift

Conversation

@Xiza73

@Xiza73 Xiza73 commented May 8, 2026

Copy link
Copy Markdown
Owner

Summary

El README estaba literalmente en su mínima expresión:

```
BotitoV2
```

Lo reescribo con info real ahora que v0.4.0 está en producción.

Contenido del nuevo README

  • Header: Xiza Bot (rebrand desde BotitoV2), badge de CI, badge de tests (284/284)
  • Tabla de comandos: 24 comandos agrupados por categoría (info / fun / mod), con un párrafo de highlights destacando los más interesantes (/love con persistencia, /help con dropdown, /clear con DM-recap, /poke color por tipo, /team)
  • Stack table: Node 22 · TS 5.9 · discord.js 14 · Mongoose 8 · Vitest 4 · pnpm 10 · Railway
  • Setup: `pnpm install`, `pnpm dev`, env vars relevantes en una tabla (TOKEN, MONGODB, OWNERID, GMI2_CHANNEL, etc.)
  • Scripts: tabla de los 5 scripts que importan
  • Estructura del repo: tree con la organización actual (manifests estáticos, slashCommands en 3 categorías, helpers compartidos)
  • Convenciones: resumen rápido (branches, commits, español neutral, branding embeds, tests co-locados, DAO directo) con link a `.claude/conventions.md` para el detalle
  • Versión actual: pointer al `/changelog` y la entrada v0.4.0

Notas

  • Los docs en `.claude/` (CLAUDE.md, conventions.md, refactor-plan.md) son locales por decisión de la Fase 1 del refactor (`.gitignore` los excluye). Los actualizo localmente para mi contexto pero no entran al repo.
  • Sin código tocado — solo documentación.

Test plan

  • `pnpm test` → 284/284 (no debería cambiar nada, es solo doc)
  • Render del README en GitHub se ve OK

The repo's docs were stuck describing the legacy state (discord.js 13,
TS 4, Node 16, prefix commands b!, /commands folder, distube). All of
that is gone since v0.4.0. Updating to reflect reality.

README.md
- Was: literally just the line 'BotitoV2'
- Now: full overview — comandos, stack, setup, env vars, scripts, repo
  structure, conventions summary, version pointer

.claude/CLAUDE.md
- Stack table updated to current versions (Node 22, TS 5.9, discord.js
  14.16, Mongoose 8.23, pnpm 10.33)
- Repo map: removed legacy /commands, removed events/distube, added
  shared/constants, marked manifest-driven loaders
- Features list rewritten around the 24 slash commands and the
  messageDelete listener
- Env vars table cleaned (PREFIX gone, USER_AGENT gone)
- Scripts table updated (pnpm, no more tsc-watch + nodemon)
- Added a Branding section documenting the facelift conventions
  (palette, no setAuthor, footer-only, signal-color exceptions)
- Reading order reframed: refactor-plan is now a historical log, not
  a roadmap

.claude/refactor-plan.md
- Status header flipped from 'Fase 7 — release pendiente' to
  '✅ COMPLETADO — v0.4.0 en producción'
- Note up top reframing the doc as a historical log
- Fase 7 section expanded with the actual work that landed (tests,
  facelift, complementary commands) and a small post-v0.4.0 backlog
  (dashboard, naming-unification deferred per owner preference)
@Xiza73 Xiza73 merged commit 0565b58 into dev May 8, 2026
2 checks passed
@Xiza73 Xiza73 deleted the docs/post-facelift branch May 8, 2026 17:24
Xiza73 added a commit that referenced this pull request May 8, 2026
Patch release for the post-v0.4.0 documentation pass (PR #64). No code
changes — only:
- README.md rewritten with the current command list, stack, setup,
  scripts, repo structure and conventions summary

Adds a 0.4.1 entry to the in-bot changelog so /changelog reflects this
release. /about and /uptime read package.json at runtime, so they pick
up the new version automatically.
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