-
Notifications
You must be signed in to change notification settings - Fork 1
Chapter on installation #7
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.
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
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
9da81f6 to
f649f7f
Compare
| 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 |
There was a problem hiding this comment.
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.
| [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. | |||
There was a problem hiding this comment.
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".
| 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 |
There was a problem hiding this comment.
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.
| [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.
|
|
||
| ## 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. |
There was a problem hiding this comment.
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.
| 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.
No description provided.