Skip to content

Latest commit

 

History

History
50 lines (38 loc) · 1.85 KB

File metadata and controls

50 lines (38 loc) · 1.85 KB

Documentation Repository Instructions

Source ownership

Before editing documentation, confirm that this repository owns the file. Several directories are mirrors replaced wholesale by upstream workflows. Never edit these paths here:

  • content/pages/docs/kcl-lang/** mirrors KittyCAD/modeling-app/docs/kcl-lang/**.
  • content/pages/docs/kcl-std/** mirrors generated KittyCAD/modeling-app/docs/kcl-std/**.
  • content/pages/docs/kcl-samples/** mirrors KittyCAD/modeling-app/public/kcl-samples/**.
  • content/kcl-test-outputs/** mirrors KittyCAD/modeling-app/rust/kcl-lib/tests/outputs/**.
  • content/pages/docs/cli/manual/zoo*.md mirrors Markdown generated by KittyCAD/cli.

For KCL language guides, edit modeling-app/docs/kcl-lang/**. The exceptions are docs/kcl-lang/settings/project.md and user.md, which are generated from the settings definitions in modeling-app/rust/kcl-lib.

For KCL standard library reference pages, edit the doc comments in modeling-app/rust/kcl-lib/std/**, then run this from modeling-app/rust:

just redo-kcl-stdlib-docs

The modeling-app generate-website-docs workflow copies KCL docs, samples, and test outputs into this repository and opens or updates the downstream pull request. For CLI reference pages, edit KittyCAD/cli, run make gen-md, and let its generate-website-docs workflow update this repository.

Zoo Design Studio product documentation under content/pages/docs/zoo-design-studio/**, KCL's handwritten landing page at content/pages/docs/kcl/index.mdx, and content/pages/docs/cli/manual/index.md are owned by this repository.

When ownership is unclear, inspect the upstream generation workflows before editing. Do not patch a generated mirror to fix its authoritative source.

Validation

Install the locked dependencies and build all documentation:

npm ci
npm run build