Skip to content

docs: refresh engineering runbooks#124

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

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

Conversation

@cursor

@cursor cursor Bot commented Jun 14, 2026

Copy link
Copy Markdown

Summary

  • Updated engineering runbooks for the current event-loader contract and release workflow tag-existence gating.
  • Corrected setup/configuration docs for explicit Prisma generation and the PRODUCTION=false MongoDB URI pitfall.
  • Refreshed command/feature docs for /rank info, ticket setup/runtime behavior, Join-to-Create limitations, database URI selection, and current test coverage.

Codepaths Covered

  • src/handlers/events.js and src/events/Guild/** event registration
  • .github/workflows/release.yml release publishing flow
  • package.json, src/example.config.js, and src/handlers/prisma.js setup/runtime config
  • src/commands/slash/General/rank.js
  • src/components/selects/ticketSSM.js, src/components/selects/ticket-menu.js, src/components/modals/ticket-modal.js, src/components/buttons/ticket-close.js
  • src/commands/slash/Management/setup.js, src/components/selects/setupSSM.js, src/events/Guild/jointocreate.js, prisma/schema.prisma
  • tests/*.test.js regression inventory

Key Knowledge Gaps Addressed

  • Removed stale docs claiming Guild object event handlers do not match the event loader.
  • Clarified releases are gated by missing v<package.version> tags, not latest-commit version-line diffs.
  • Documented that Prisma client generation is explicit and no postinstall hook exists.
  • Clarified that local PRODUCTION=false still selects MONGODB_URI for runtime MongoDB URI selection.
  • Corrected /rank info to require a user and documented rank-card presence normalization.
  • Documented current ticket setup/JTC limitations so operators do not expect unsupported automation.

Verification

  • git diff --check
  • npm test (37/37 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