Skip to main content

crimoo-internal-docs

Purpose and Production Relevance​

crimoo-internal-docs is the internal Docusaurus documentation app for Crimoo developers. It contains architecture, service, flow, and learning documentation. The Crimoo Mastery Study Docs live here.

Production relevance: internal developer documentation app, not runtime code.

Stack and Main Dependencies​

  • Docusaurus.
  • React.
  • TypeScript.
  • Mermaid support through @docusaurus/theme-mermaid.
  • Markdown/MDX.

Important files and folders:

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

Business Responsibilities​

  • Preserve internal architecture decisions.
  • Document production service boundaries.
  • Explain cross-service flows.
  • Keep debugging and operational knowledge available.
  • Provide learning material for developers and future Codex skills.

Technical Architecture and Source-Code Entry Points​

The sidebar is autogenerated from the docs folder. Category metadata lives in _category_.json files. Mermaid diagrams are enabled in Docusaurus config.

This learning pack uses:

  • docs/learning/learning-path.md
  • docs/learning/project-map.md
  • docs/learning/business-logic.md
  • docs/learning/skill-consultation-index.md
  • docs/learning/projects/*.md

Key Data Flows and Service Integrations​

No runtime product data flow. The app statically builds docs.

Documentation flow:

  1. Inspect code and existing docs.
  2. Update relevant Markdown pages.
  3. Run Docusaurus build.
  4. Fix broken links or invalid Markdown.
  5. Commit docs-only changes.

Environment, Deploy, and Runtime Notes​

Common commands:

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

Debugging Checklist​

  • If build fails, inspect Docusaurus broken-link output first.
  • If Mermaid fails, check fenced code block syntax and labels.
  • If sidebar ordering is wrong, check _category_.json and sidebar_position.
  • If content duplicates another page, prefer linking to the authoritative flow/service page.
  • If docs disagree with code, inspect the code and update the docs with the concrete owner/path.

Tests or Validation Commands​

cd crimoo-internal-docs
npm run build
npm run typecheck

Mastery Checklist​

  • Add a new docs section with category metadata and stable sidebar order.
  • Link across docs without creating broken Docusaurus links.
  • Decide whether content belongs in internal docs, public docs, or a project README.
  • Keep skill-style indexes concise and current.