Skip to content

docs(readme): update quickstart, structure, endpoints, admin docs#1

Open
pierringshot wants to merge 1 commit into
feat/maverick-v5.0.1-setupfrom
feat/maverick-v5.0.1-layered
Open

docs(readme): update quickstart, structure, endpoints, admin docs#1
pierringshot wants to merge 1 commit into
feat/maverick-v5.0.1-setupfrom
feat/maverick-v5.0.1-layered

Conversation

@pierringshot
Copy link
Copy Markdown
Member

@pierringshot pierringshot commented Sep 14, 2025

Summary

  • What change does this PR introduce and why?
  • Link any related issue(s): Fixes #

Checklist

  • Code follows project structure (route → controller → service → utils).
  • Input validation added/updated where applicable (schemas/).
  • No secrets added to code; config via .env only.
  • Lint passes: npm run lint (from WhatsCore.AI_5.0.1/).
  • Tests pass locally: SKIP_WHATSAPP=true npm test.
  • Updated docs (AGENTS.md/README, Swagger docs/openapi.yaml if API changes).
  • Considered backward compatibility; API contracts unchanged or documented.

Testing Notes

  • Steps to reproduce and verify the change locally:
    1. cd WhatsCore.AI_5.0.1 && npm install
    2. SKIP_WHATSAPP=true npm test
    3. (If applicable) describe manual validation (e.g., /api calls)

Screenshots / Logs (optional)

Deployment Considerations

  • Requires env/config changes
  • Data migrations or one-off scripts

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