Skip to content

Commit 6f96a9a

Browse files
authored
Nickmccleery/link cleanup (#566)
* Update link. * Link updated. * Link updates. * Update links. * Link updates.
1 parent dc79b7b commit 6f96a9a

File tree

8 files changed

+31
-26
lines changed

8 files changed

+31
-26
lines changed

content/glossary/endpoint.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ synonyms:
1010
domains:
1111
- software-engineering
1212
---
13-
When discussing [APIs](/glossary/application-programming-interface-api), an "endpoint" is a single service that is offered by a [host](/glossary/host) software that can be requested by a [client](/glossary/client). An endpoint on an API hosted on the internet is usually represented by a URL, such as `https://api.zoo.dev/user`.
13+
When discussing [APIs](/docs/glossary/application-programming-interface-api), an "endpoint" is a single service that is offered by a [host](/docs/glossary/host) software that can be requested by a [client](/docs/glossary/client). An endpoint on an API hosted on the internet is usually represented by a URL, such as `https://api.zoo.dev/user`.
1414

1515
Some endpoints may ask the host to fetch and return some data, like [getting your user](https://zoo.dev/docs/api/users/get-your-user), or ask them to perform some work for the client and return the result, like [converting a CAD file](https://zoo.dev/docs/api/file/convert-cad-file-with-defaults).
1616

content/pages/docs/faq/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ excerpt: Frequently asked questions about KittyCAD and the Zoo Modeling App (ZMA
5252
<details>
5353
<summary>Where can I start using the ML-ephant API?</summary>
5454

55-
Our AI API can be found [here in our documentation](https://zoo.dev/docs/api/ai?lang=python). If you would like assistance getting started, we also created a [tutorial to create your own Text-to-CAD API call](https://zoo.dev/docs/tutorials/text-to-cad).
55+
Our AI API can be found [here in our documentation](https://zoo.dev/docs/developer-tools/api/ml?lang=python). If you would like assistance getting started, we also created a [tutorial to create your own Text-to-CAD API call](https://zoo.dev/docs/tutorials/text-to-cad).
5656

5757
</details>
5858

content/pages/docs/kcl-lang/modules.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ excerpt: "Documentation of the KCL language for the Zoo Design Studio."
44
layout: manual
55
---
66

7-
`KCL` allows splitting code up into multiple files. Each file is somewhat
7+
`KCL` allows splitting code up into multiple files. Each file is somewhat
88
isolated from other files as a separate module.
99

1010
When you define a function, you can use `export` before it to make it available
@@ -84,11 +84,13 @@ fn cube(center) {
8484
myCube = cube(center = [0, 0])
8585
```
8686

87-
*Pros*
87+
_Pros_
88+
8889
- Any argument can be a parameter – size, position, appearance, etc.
8990
- Works great inside loops, arrays, or optimisation sweeps.
9091

91-
*Cons*
92+
_Cons_
93+
9294
- Every invocation rebuilds the entire feature tree.
9395
- **Slower** than a straight duplicate – each call is its own render job.
9496

@@ -97,17 +99,19 @@ myCube = cube(center = [0, 0])
9799
```kcl
98100
sketch001 = startSketchOn(-XZ)
99101
|> circle(center = [0, 0], radius = 10)
100-
|> extrude(length = 5)
102+
|> extrude(length = 5)
101103
|> appearance(color = "#ff0000", metalness = 90, roughness = 90)
102104
103105
sketch002 = clone(sketch001) // ✓ instant copy
104106
```
105107

106-
*Pros*
108+
_Pros_
109+
107110
- Roughly an O(1) operation – we just duplicate the underlying engine handle.
108111
- Perfect when you need ten identical bolts or two copies of the same imported STEP file.
109112

110-
*Cons*
113+
_Cons_
114+
111115
- **Not parametric** – the clone is exactly the same shape as the source.
112116
- If you need to tweak dimensions per‑instance, you’re back to a function.
113117

@@ -156,7 +160,7 @@ Defining a function inside a module is instantaneous – we just record the byte
156160
export fn makeBolt(size) { /* … expensive CAD … */ }
157161
```
158162

159-
If `main.kcl` waits until the very end to call `makeBolt`, *none* of that work was parallelised – you’ve pushed the cost back onto the serial tail of your script.
163+
If `main.kcl` waits until the very end to call `makeBolt`, _none_ of that work was parallelised – you’ve pushed the cost back onto the serial tail of your script.
160164

161165
**Better:** call it early or move the invocation into another module.
162166

@@ -251,12 +255,12 @@ file represents object(s) in memory. If you import the same file multiple times,
251255
it will only be rendered once.
252256

253257
If you want to have multiple instances of the same object, you can use the
254-
[`clone`](/docs/kcl/clone) function. This will render a new instance of the object in memory.
258+
[`clone`](/docs/kcl-std/functions/std-clone) function. This will render a new instance of the object in memory.
255259

256260
```norun
257261
import cube from "cube.kcl"
258262
259-
cube
263+
cube
260264
|> translate(x=10)
261265
clone(cube)
262266
|> translate(x=20)

content/pages/privacy-policy.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ We may collect personal information automatically when you use the Services.
4444
- **Device Information**. We may collect personal information about your device, such as your Internet protocol (IP) address, user settings, cookie identifiers, other unique identifiers, browser or device information, Internet service provider, and location information (including, as applicable, approximate location derived from IP address and precise geo-location information).
4545
- **Usage Information**. We may collect personal information about your use of the Services, such as the pages that you visit, items that you search for, the types of content you interact with, information about the links you click, the frequency and duration of your activities, and other information about how you use the Services.
4646
- **Cookie Notice (and Other Technologies)**. We, as well as third parties, may use cookies, pixel tags, and other technologies (“Technologies”) to automatically collect personal information through your use of the Services. *See “[Your Privacy Choices and Rights](#your-privacy-choices-and-rights)” below to understand your choices regarding these Technologies.*
47-
- **Cookies**. [Cookies](/glossary/cookie) are small text files stored in device browsers.
47+
- **Cookies**. [Cookies](/docs/glossary/cookie) are small text files stored in device browsers.
4848
- **Pixel Tags/Web Beacons**. A pixel tag (also known as a web beacon) is a piece of code embedded in the Services that collects personal information about use of or engagement with the Services. The use of a pixel tag allows us to record, for example, that a user has visited, a particular web page or clicked on a particular advertisement. We may also include web beacons in e-mails to understand whether messages have been opened, acted on, or forwarded.
4949

5050
### Personal Information Collected from Third Parties

content/posts/mechanical-cad-yesterday-today-and-tomorrow.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Much like VSCode and other editors have nice plugins for offloading tests to oth
8888

8989
## User Experience and Design
9090

91-
After trying numerous different industry CAD programs, most have one thing in common: a user interface that looks like it is from the 90s. It is a bit ironic that a tool used for mechanical design has not considered the design and experience of its user interface. Most CAD programs are in need of a makeover, however there are a couple outliers that do interface design well. [Shapr3D](https://www.shapr3d.com/), an iPad CAD app, has a great design and very intuitive interface. [SketchUp](https://www.sketchup.com/products/sketchup-pro) has a more intuitive and beautiful design.
91+
After trying numerous different industry CAD programs, most have one thing in common: a user interface that looks like it is from the 90s. It is a bit ironic that a tool used for mechanical design has not considered the design and experience of its user interface. Most CAD programs are in need of a makeover, however there are a couple outliers that do interface design well. [Shapr3D](https://www.shapr3d.com/), an iPad CAD app, has a great design and very intuitive interface. [SketchUp](https://www.sketchup.com/en) has a more intuitive and beautiful design.
9292

9393
Additionally, CAD applications need to be native on MacOS, Linux, and Windows. Native applications built for their specific platform perform better than ones built with Electron[^11] and the like. Especially for a program as graphics heavy as CAD, it is best to utilize the underlying OS graphics mechanisms to get the best performance possible. Today, you can only use CAD programs on the single OS that is supported by that specific program. Additionally, most of them use archaic GUI frameworks that truly show their age.
9494

content/posts/text-to-cad-blender-addon.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ogImage:
1111
url: 'documentation-assets/meta-images/text-to-cad-blender-blog.jpg'
1212
---
1313

14-
Today we are introducing our [Text-to-CAD add-on for Blender](https://github.com/KittyCAD/text-to-cad-blender-addon). In the world of digital design and 3D modeling, the bridge between conceptualization and realization is crucial. Powered by [Zoo.dev](https://zoo.dev/)'s [ML-ephant Machine Learning API](https://zoo.dev/docs/api/ai), this add-on allows users to generate CAD models directly from text descriptions.
14+
Today we are introducing our [Text-to-CAD add-on for Blender](https://github.com/KittyCAD/text-to-cad-blender-addon). In the world of digital design and 3D modeling, the bridge between conceptualization and realization is crucial. Powered by [Zoo.dev](https://zoo.dev/)'s [ML-ephant Machine Learning API](https://zoo.dev/docs/developer-tools/api/ml), this add-on allows users to generate CAD models directly from text descriptions.
1515
### What is Text-to-CAD?
1616
So glad you asked! Our CEO Jessie Frazelle has actually already written a nice [blog post](/blog/introducing-text-to-cad) describing our Text-to-CAD technology.
1717

content/posts/turning-on-billing-for-text-to-cad.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ogImage:
1212

1313
On Monday, January 15th, we will be turning on billing for [Text-to-CAD](https://zoo.dev/text-to-cad). Let’s go over a bit about what this means. Our APIs and tools have pay-as-you-go pricing. You get 40 free minutes of API access per month, followed by a cost of $0.50 per minute for additional usage.
1414

15-
Let’s break this down for a common Text-to-CAD workflow. When you generate a model in the [Text-to-CAD UI](https://text-to-cad.zoo.dev), you are paying for the server time it takes to generate that model. The artifacts that come from the initial API call are a STEP file and a glTF file. If you then use the UI to download an STL file (or any other format), you are paying for the server time to convert the file to an STL. While that is essentially two API calls, it’s better to think of it as the server time. For example, if you directly call our [Text-to-CAD API endpoint](https://zoo.dev/docs/api/ai/generate-a-cad-model-from-text?lang=python) and request an STL at that time, it’s a single API call, _BUT_ still the same amount of server time. Therefore, it’s easier to think about it in terms of server time versus the number of API calls. You are not charged for any failed API calls[^1]. Billing also applies to requests made through our Discord bot, since it is authenticated with your Discord account.
15+
Let’s break this down for a common Text-to-CAD workflow. When you generate a model in the [Text-to-CAD UI](https://text-to-cad.zoo.dev), you are paying for the server time it takes to generate that model. The artifacts that come from the initial API call are a STEP file and a glTF file. If you then use the UI to download an STL file (or any other format), you are paying for the server time to convert the file to an STL. While that is essentially two API calls, it’s better to think of it as the server time. For example, if you directly call our [Text-to-CAD API endpoint](https://zoo.dev/docs/developer-tools/api/ml/generate-a-cad-model-from-text) and request an STL at that time, it’s a single API call, _BUT_ still the same amount of server time. Therefore, it’s easier to think about it in terms of server time versus the number of API calls. You are not charged for any failed API calls[^1]. Billing also applies to requests made through our Discord bot, since it is authenticated with your Discord account.
1616

1717
For example, my prompt `a brick: 10 in. long 4 in. deep 2 in. tall—with chamfered edges` took just under a minute so that would be $0.50. If I then download an STL (which requires paying for the server time for the conversion), that would be another $0.50. If I download a STEP or glTF file, that does not require an additional charge since those were the artifacts of the initial API call.
1818

content/tutorials/text-to-cad.mdx

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'Text-to-CAD Tutorial'
2+
title: "Text-to-CAD Tutorial"
33
excerpt: In this tutorial we'll walk through how to use our Text-to-CAD API endpoint in a Python script.
44
---
55

@@ -9,19 +9,19 @@ This tutorial will walk you through how to use our Text-to-CAD API endpoint from
99

1010
Our objective is to use the API to:
1111

12-
* Give a text prompt
13-
* Receive a CAD file in response
14-
* Save the CAD file to our local machine
12+
- Give a text prompt
13+
- Receive a CAD file in response
14+
- Save the CAD file to our local machine
1515

1616
## Let's get started
1717

1818
Before you can use our API, you must have an API key. When you send an API command, you will pass this API key along with your command, so that we can verify it's you.
1919

2020
You will see your API token below if you are signed in and have already generated one. If all you see is "Generate your first API token," then you currently do not have a token. Follow the steps below to generate an API key:
2121

22-
* Create an account. If you haven't already, you can [create an account here](/account)
23-
* Sign in. Once you've signed up for an account, make sure you are signed in.
24-
* Generate an API key. You can either go into your [account settings](/account?tab=api_tokens) to generate an API key, or you can press the button below and we will take care of it for you!
22+
- Create an account. If you haven't already, you can [create an account here](/account)
23+
- Sign in. Once you've signed up for an account, make sure you are signed in.
24+
- Generate an API key. You can either go into your [account settings](/account?tab=api_tokens) to generate an API key, or you can press the button below and we will take care of it for you!
2525

2626
<MarkDownAPITokens />
2727

@@ -35,12 +35,12 @@ In your terminal, use the command `pip install kittycad` to install the `kittyca
3535

3636
Let's start building the script. Create a new file with the `.py` extension and open it in your preferred editor.
3737

38-
First, we need to import the necessary libraries. You can reference our AI API documentation [here](https://zoo.dev/docs/api/ai?lang=python).
38+
First, we need to import the necessary libraries. You can reference our AI API documentation [here](https://zoo.dev/docs/developer-tools/api/ml?lang=python).
3939

4040
There are two API calls that we are going to make.
4141

42-
1. [Generate a CAD model from text](https://zoo.dev/docs/api/ai/generate-a-cad-model-from-text?lang=python)
43-
2. [List Text-to-CAD models you've generated](https://zoo.dev/docs/api/ai/list-text-to-cad-models-you've-generated?lang=python)
42+
1. [Generate a CAD model from text](https://zoo.dev/docs/developer-tools/api/ml/generate-a-cad-model-from-text?lang=python)
43+
2. [List Text-to-CAD models you've generated](https://zoo.dev/docs/developer-tools/api/ml/list-text-to-cad-models-you've-generated?lang=python)
4444

4545
Import the libraries necessary to create and retrieve models with Text-to-CAD:
4646

@@ -146,4 +146,5 @@ elif result.status == ApiCallStatus.COMPLETED:
146146
Feel free to reference or copy the full script below:
147147

148148
```py data-file="public/litterbox_assets/tutorials/text-to-cad/text-to-cad.py"
149-
```
149+
150+
```

0 commit comments

Comments
 (0)