Contains source Markdown files for Zoo's documentation. Handwritten pages live alongside directories mirrored from other repositories.
Did you find a typo? Please make a pull request!
Edit generated documentation in its authoritative repository. Changes made to the downstream mirrors in this repository will be overwritten.
| Path in this repository | Authoritative source |
|---|---|
content/pages/docs/kcl-lang/** |
KittyCAD/modeling-app docs/kcl-lang/** |
content/pages/docs/kcl-std/** |
modeling-app/rust/kcl-lib/std/** doc comments, rendered into modeling-app/docs/kcl-std/** |
content/pages/docs/kcl-samples/** |
modeling-app/public/kcl-samples/** |
content/kcl-test-outputs/** |
modeling-app/rust/kcl-lib/tests/outputs/** |
content/pages/docs/cli/manual/zoo*.md |
KittyCAD/cli, generated with make gen-md |
The remaining file in the CLI manual, index.md, is handwritten here. The
API reference is generated separately and is not
stored in this repository.
See AGENTS.md for generator commands and the exact ownership
rules used by coding agents.
When adding a FramedImage, set aspect to the source image's width and height
(or an equivalent ratio such as 1 / 1 for a square image). Run
npm run check:images to compare these values with the image files. The pull
request build runs the same check and rejects differences above 5%.
Use frameAspect when a different frame shape is intentional; the image will
remain undistorted inside that frame.
If you have access to our website repository and you'd like to live preview your content in the website as your write/edit it, head over to that repo's README to get instructions on how to set it up.