Pular para o conteúdo principal

crimoo-docs

Purpose and Production Relevance​

crimoo-docs is the public/user-facing Docusaurus documentation app. It explains installation, verification, CRM concepts, and capture configuration from an end-user perspective.

Production relevance: public documentation app, not runtime code.

Stack and Main Dependencies​

  • Docusaurus.
  • React.
  • TypeScript.
  • MDX/Markdown docs.

Important files and folders:

  • crimoo-docs/docs
  • crimoo-docs/src
  • crimoo-docs/docusaurus.config.ts
  • crimoo-docs/sidebars.ts
  • crimoo-docs/package.json

Business Responsibilities​

  • Teach users how to install and verify Crimoo.
  • Explain capture rules, field mapping, trigger types, CRM contacts, and custom fields.
  • Provide customer-facing product guidance.

Technical Architecture and Source-Code Entry Points​

Docusaurus app with generated/static docs pages. Docs live under docs; custom page rendering code lives under src.

Key Data Flows and Service Integrations​

No runtime product data flow. The docs should mirror product behavior accurately and link users to correct setup concepts.

Environment, Deploy, and Runtime Notes​

Common commands:

cd crimoo-docs
npm install
npm run start
npm run build
npm run typecheck

Debugging Checklist​

  • If build fails, check broken links, invalid frontmatter, MDX syntax, and missing assets.
  • If docs are inaccurate, compare against crimoo-internal-docs and current code.
  • Keep user docs simpler than internal docs and avoid leaking internal deployment details.

Tests or Validation Commands​

cd crimoo-docs
npm run build
npm run typecheck

Mastery Checklist​

  • Know the difference between public docs and internal docs.
  • Update user docs when a product workflow changes.
  • Keep public docs focused on user outcomes, not internal architecture.