Skip to content

Document editing project text files #1066

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
pierremtb wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Document editing project text files #1066

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1fa57ea
Document editing project text files
pierremtb Oct 1, 2026
71470e0
Document single-click opening for text-based CAD files
pierremtb Oct 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion content/pages/docs/zoo-design-studio/features/workspace/code-editor.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
---
title: Code Editor
excerpt: Edit KCL directly inside Zoo Design Studio.
excerpt: Edit KCL and project text files directly inside Zoo Design Studio.
sidebarPosition: 5
---

The Code Editor is the KCL source panel for the active model.
It also opens project text files selected in the
[File Explorer](/docs/zoo-design-studio/features/workspace/file-explorer#open-text-files).

## What You Can Do

- Edit the model directly in KCL.
- Format code, copy code, and open KCL docs from the pane menu.
- Use diagnostics, lint markers, and syntax-aware editor behavior.
- Use undo and redo within the app's editing workflow.
- Edit UTF-8 project text files up to 1 MiB with automatic saving. Markdown files have syntax
highlighting; other non-KCL text files use plain text editing.

## What You Cannot Do

Expand Down
11 changes: 11 additions & 0 deletions content/pages/docs/zoo-design-studio/features/workspace/file-explorer.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,19 @@ The File Explorer shows the files and folders inside the current project.
- Archive entries you no longer need.
- [Add files from your computer](/docs/zoo-design-studio/features/data-management/import#add-file-to-project) by dragging them into Project Files in the browser or desktop app.
- Open `.kcl` files directly for editing.
- Open UTF-8 text files, including JSON, YAML, TOML, source files, and files without an extension.
- Reveal the project, or an individual file or folder, in the system file manager on desktop.

## Open Text Files

Click a text file in Project Files to open it in the Code Editor. Edits save automatically.
Text files can be up to 1 MiB. Binary files and files in other text encodings cannot be edited.
Enable **Show All Files** in user settings to see hidden files and configuration files such as
`project.toml`.

Text-based CAD files such as STEP or OBJ also open with a click. To import a CAD file into the
model, right-click it and choose **Import in current file**.

## Reveal in the System File Manager

Use `Reveal in file explorer` when you need to work with a project in Finder, File Explorer, or your
Expand Down
Loading