Skip to content

Conversation

@adamchalmers
Copy link
Collaborator

No description provided.

@vercel
Copy link

vercel bot commented May 14, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
kcl-book ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 14, 2025 1:32am

Our [GitHub] for Zoo Design Studio has all of our developer tooling and the language runtime. Please take a look there if you'd like to open any bugs or contribute to KCL! This book itself is [available on GitHub too]. Feel free to open issues or PRs.

[available on GitHub too]: https://github.com/KittyCAD/kcl-book
[GitHub]: https://github.com/KittyCAD/modeling-app
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The URL for the LSP link appears to be incorrect - it currently points to the main modeling-app repository (same as the GitHub link). Please update this to point to the specific LSP repository or documentation page to ensure users can find the appropriate language server resources.

Suggested change
[GitHub]: https://github.com/KittyCAD/modeling-app
[LSP]: https://github.com/KittyCAD/lsp

Spotted by Diamond

Is this helpful? React 👍 or 👎 to let us know.

Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com>
@@ -0,0 +1,26 @@
# Installation

There are two main ways to work with KCL. You can use [Zoo Design Studio], our all-in-one application built specifically for KCL designs, or you can use a traditional programming interface with your own text editor. We definitely recommend the Zoo Design Studio.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sentence should be "There are two main ways" instead of "There's two main ways" since "ways" is plural and requires the plural verb form "are".

Suggested change
There are two main ways to work with KCL. You can use [Zoo Design Studio], our all-in-one application built specifically for KCL designs, or you can use a traditional programming interface with your own text editor. We definitely recommend the Zoo Design Studio.
There are two main ways to work with KCL. You can use [Zoo Design Studio], our all-in-one application built specifically for KCL designs, or you can use a traditional programming interface with your own text editor. We definitely recommend the Zoo Design Studio.

Spotted by Diamond

Is this helpful? React 👍 or 👎 to let us know.


[available on GitHub too]: https://github.com/KittyCAD/kcl-book
[GitHub]: https://github.com/KittyCAD/modeling-app
[LSP]: https://github.com/KittyCAD/modeling-app
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The URL for the LSP link appears to be incorrect - it currently points to the same repository as the GitHub link (https://github.com/KittyCAD/modeling-app). Please update the LSP link to point to the specific repository or path where the Language Server Protocol implementation can be found.

Suggested change
[LSP]: https://github.com/KittyCAD/modeling-app
[LSP]: https://microsoft.github.io/language-server-protocol/

Spotted by Diamond

Is this helpful? React 👍 or 👎 to let us know.

@adamchalmers adamchalmers merged commit f3b3cce into main May 14, 2025
7 checks passed
@adamchalmers adamchalmers deleted the achalmers/installation-chapter branch May 14, 2025 01:34

## Traditional code editing

You can download the [Zoo CLI], which lets you execute KCL programs and download some sort of visualization. You can download your KCL models as 3D files or as 2D images. Use `zoo kcl --help` to learn more.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The phrase "download some sort of visualization" lacks specificity and may confuse users. Consider replacing it with more precise language about the CLI's output capabilities, such as "execute KCL programs and export the resulting models as 3D files or 2D images." This would give readers a clearer understanding of what they can expect from the CLI tool.

Suggested change
You can download the [Zoo CLI], which lets you execute KCL programs and download some sort of visualization. You can download your KCL models as 3D files or as 2D images. Use `zoo kcl --help` to learn more.
You can download the [Zoo CLI], which lets you execute KCL programs and export the resulting models as 3D files or 2D images. Use `zoo kcl --help` to learn more.

Spotted by Diamond

Is this helpful? React 👍 or 👎 to let us know.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants