Skip to content

docs: refresh engineering runbooks#120

Draft
cursor[bot] wants to merge 1 commit into
mainfrom
cursor/engineering-documentation-updates-5323
Draft

docs: refresh engineering runbooks#120
cursor[bot] wants to merge 1 commit into
mainfrom
cursor/engineering-documentation-updates-5323

Conversation

@cursor

@cursor cursor Bot commented Jun 12, 2026

Copy link
Copy Markdown

Summary

  • Updated existing engineering docs for current event-loader, interaction routing, command deployment, release automation, setup, database, and feature behavior.
  • Corrected setup/configuration guidance for explicit npx prisma generate, external nodemon, PRODUCTION truthiness, and distinct DEV_GUILD_ID vs config.handler.guildId codepaths.
  • Clarified partial or constrained feature paths for tickets, Join-to-Create, and manually managed rank/XP records.

Codepaths Covered

  • src/handlers/events.js and src/events/validations/**
  • src/events/Guild/interactionCreate.js, components.js, messageCreate.js, and jointocreate.js
  • src/events/ready/registerCommands.js and registerContextMenus.js
  • .github/workflows/release.yml
  • src/example.config.js, src/handlers/prisma.js, prisma/schema.prisma
  • /setup, ticket handlers, and /rank command implementation

Knowledge Gaps Addressed

  • Removed stale caveats that Guild { event, run } handlers were not registered.
  • Replaced outdated release version-line-diff wording with missing-tag gating.
  • Documented the MongoDB PRODUCTION=false truthiness pitfall and the no-postinstall Prisma generation requirement.
  • Synced contributor docs with current event-loader contracts and test inventory.

Validation

  • git diff --check
  • npm test (37 tests passing)
Open in Web View Automation 

Co-authored-by: zVapor_ <contact@zvapor.xyz>
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