Back to Lowdefy

Lowdefy Monorepo Documentation Plan

code-docs/DOCUMENTATION_PLAN.md

5.2.04.2 KB
Original Source

Lowdefy Monorepo Documentation Plan

Generated: 2026-01-08 Framework Version: 4.4.0

Progress Overview

  • Phase 1: Foundation
  • Phase 2: Core Packages
  • Phase 3: Plugin System
  • Phase 4: Architecture Docs
  • Phase 5: Servers & Utils
  • Phase 6: Validation

Phase 1: Foundation

  • code-docs/Overview.md
  • code-docs/Philosophy.md
  • code-docs/.metadata/monorepo-structure.json

Phase 2: Core Packages

packages/api

  • code-docs/packages/api.md

packages/build

  • code-docs/packages/build.md

packages/cli

  • code-docs/packages/cli.md

packages/client

  • code-docs/packages/client.md

packages/engine

  • code-docs/packages/engine.md

packages/layout

  • code-docs/packages/layout.md

packages/operators

  • code-docs/packages/operators.md

Phase 3: Plugin System

Blocks (packages/plugins/blocks/)

  • code-docs/plugins/blocks/overview.md
  • code-docs/plugins/blocks/antd.md
  • code-docs/plugins/blocks/basic.md
  • code-docs/plugins/blocks/aggrid.md
  • code-docs/plugins/blocks/echarts.md
  • code-docs/plugins/blocks/markdown.md
  • code-docs/plugins/blocks/google-maps.md
  • code-docs/plugins/blocks/algolia.md
  • code-docs/plugins/blocks/loaders.md
  • code-docs/plugins/blocks/qr.md

Connections (packages/plugins/connections/)

  • code-docs/plugins/connections/overview.md
  • code-docs/plugins/connections/mongodb.md
  • code-docs/plugins/connections/axios-http.md
  • code-docs/plugins/connections/knex.md
  • code-docs/plugins/connections/elasticsearch.md
  • code-docs/plugins/connections/google-sheets.md
  • code-docs/plugins/connections/redis.md
  • code-docs/plugins/connections/sendgrid.md
  • code-docs/plugins/connections/stripe.md

Operators (packages/plugins/operators/)

  • code-docs/plugins/operators/overview.md
  • code-docs/plugins/operators/js.md
  • code-docs/plugins/operators/mql.md
  • code-docs/plugins/operators/moment.md
  • code-docs/plugins/operators/nunjucks.md
  • code-docs/plugins/operators/change-case.md
  • code-docs/plugins/operators/diff.md
  • code-docs/plugins/operators/uuid.md
  • code-docs/plugins/operators/yaml.md
  • code-docs/plugins/operators/jsonata.md

Actions (packages/plugins/actions/)

  • code-docs/plugins/actions/overview.md
  • code-docs/plugins/actions/core.md
  • code-docs/plugins/actions/pdf-make.md

Plugins (packages/plugins/plugins/)

  • code-docs/plugins/plugins/overview.md
  • code-docs/plugins/plugins/next-auth.md
  • code-docs/plugins/plugins/aws.md
  • code-docs/plugins/plugins/csv.md
  • code-docs/plugins/plugins/auth0.md

Phase 4: Architecture Docs

  • code-docs/architecture/build-pipeline.md
  • code-docs/architecture/request-lifecycle.md
  • code-docs/architecture/state-management.md
  • code-docs/architecture/plugin-system.md
  • code-docs/architecture/auth-system.md
  • code-docs/architecture/operator-system.md

Phase 5: Servers & Utils

Servers (packages/servers/)

  • code-docs/servers/overview.md
  • code-docs/servers/server.md
  • code-docs/servers/server-dev.md

Utils (packages/utils/)

  • code-docs/utils/overview.md
  • code-docs/utils/helpers.md
  • code-docs/utils/node-utils.md
  • code-docs/utils/ajv.md
  • code-docs/utils/block-utils.md
  • code-docs/utils/block-dev.md
  • code-docs/utils/nunjucks.md
  • code-docs/utils/jest-yaml-transform.md

Phase 6: Validation

  • Verify all internal links work
  • Check cross-references between docs
  • Ensure Overview.md links to all sections
  • Review for completeness

Validation Results

  • Total Documentation Files: 65 markdown files + 1 JSON metadata
  • All internal links verified: 55 cross-references validated
  • Overview.md updated: Links to all 6 architecture docs, 5 plugin categories, 3 servers, 3 utils, 7 core packages
  • Directory Structure: 11 directories organized by category

Notes

  • Use /lf:docs-package <name> to document individual packages
  • Use /lf:docs-plugin <category>/<name> for plugins
  • Use /lf:docs-architecture <topic> for architecture docs
  • Use /lf:docs-update after code changes