Skip to content

Redirect developer links, remove FAQ. #526

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Contains source markdown files for the handwritten parts of our docs.

Did you find a typo? Please make a pull request!

Note that the [API reference](https://zoo.dev/docs/api) and the [CLI docs](https://zoo.dev/docs/cli/manual) are generated hence why they're not included.
Note that the [API reference](https://zoo.dev/docs/api) and the [CLI docs](https://zoo.dev/docs/developer-tools/cli/manual) are generated hence why they're not included.

## Live content edit preview

Expand Down
2 changes: 1 addition & 1 deletion content/glossary/client.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ domains:
- software-engineering
---

When discussing [APIs](/docs/glossary/application-programming-interface-api), a "client" is a machine or application making a request of a [host](/docs/glossary/host) software. Usually a client is requesting the host to return some data, such as all of the posts in your social media feed, or to perform some work on their behalf, such as [converting a 3D model to a different file type](/docs/api/file/convert-cad-file-with-defaults).
When discussing [APIs](/docs/glossary/application-programming-interface-api), a "client" is a machine or application making a request of a [host](/docs/glossary/host) software. Usually a client is requesting the host to return some data, such as all of the posts in your social media feed, or to perform some work on their behalf, such as [converting a 3D model to a different file type](/docs/developer-tools/api/file/convert-cad-file-with-defaults).

Within Zoo, your software (and a lot of others!) is the client, and we are the host. That's why we've gotten a team of excellent software infrastructure engineers together to make our API fast even as more and more clients use it.
2 changes: 1 addition & 1 deletion content/glossary/endpoint.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ domains:
---
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`.

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).
Some endpoints may ask the host to fetch and return some data, like [getting your user](https://zoo.dev/docs/developer-tools/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/developer-tools/api/file/convert-cad-file-with-defaults).

Zoo has endpoints for hardware design actions, managing your user, and more.
10 changes: 5 additions & 5 deletions content/pages/docs/cli/manual/index.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
---
title: 'CLI Manual'
excerpt: 'The command-line interface for Zoo.'
title: "CLI Manual"
excerpt: "The command-line interface for Zoo."
---

Zoo CLI, or `zoo`, is a command-line interface to Zoo for use in your terminal or your scripts.

- [Available commands](/docs/cli/manual/zoo)
- [Available commands](/docs/developer-tools/cli/manual/zoo)

## Installation

You can find installation instructions on [the latest release](https://github.com/KittyCAD/cli/releases).

## Configuration

Run [`zoo auth login`](/docs/cli/manual/zoo_auth_login) to authenticate with your Zoo account. Alternatively, `zoo` will respect the `ZOO_TOKEN` [environment variable](/docs/cli/manual/zoo#about).
Run [`zoo auth login`](/docs/developer-tools/cli/manual/zoo_auth_login) to authenticate with your Zoo account. Alternatively, `zoo` will respect the `ZOO_TOKEN` [environment variable](/docs/developer-tools/cli/manual/zoo#about).

Declare your aliases for often-used commands with [`zoo alias set`](/docs/cli/manual/zoo_alias_set).
Declare your aliases for often-used commands with [`zoo alias set`](/docs/developer-tools/cli/manual/zoo_alias_set).

## Support

Expand Down
2 changes: 1 addition & 1 deletion content/pages/docs/enterprise/saml/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ with SAML SSO. Zoo uses the `urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST` bin
You can configure SAML SSO for an individual organization.

The SP metadata for an organization on zoo.dev is available at
[`/org/saml/idp`](https://zoo.dev/docs/api/orgs/get-the-saml-identity-provider).
[`/org/saml/idp`](https://zoo.dev/docs/developer-tools/api/orgs/get-the-saml-identity-provider).

| Value | Other names | Description Example |
|-------|-------------|---------------------|
Expand Down
130 changes: 0 additions & 130 deletions content/pages/docs/faq/index.mdx

This file was deleted.

2 changes: 1 addition & 1 deletion content/posts/api-first-approach.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Our products aren't 3D modeling software suites. We make tools that allow any so

To support any application big or small, KittyCAD's functionality is broken up into many individual services, called endpoints. This is our API, and it allows developers to build in only the functionality they need, and leave out whatever they don’t.

You may build a file converter app just using our [convert](https://zoo.dev/docs/api/file/convert-cad-file-with-defaults) API endpoint, while someone building a full-featured CAD suite may use our [design endpoints](https://zoo.dev/docs/api/modeling/open-a-websocket-which-accepts-modeling-commands) to let their users generate 3D models through a traditional user interface. Both these developers got only the features they needed, and both haven't had to think about the complexities of CAD file formats, [rendering engines](https://zoo.dev/geometry-engine), or most of the other thorny problems of building hardware design tools. That's what KittyCAD is for.
You may build a file converter app just using our [convert](https://zoo.dev/docs/developer-tools/api/file/convert-cad-file-with-defaults) API endpoint, while someone building a full-featured CAD suite may use our [design endpoints](https://zoo.dev/docs/developer-tools/api/modeling/open-a-websocket-which-accepts-modeling-commands) to let their users generate 3D models through a traditional user interface. Both these developers got only the features they needed, and both haven't had to think about the complexities of CAD file formats, [rendering engines](https://zoo.dev/geometry-engine), or most of the other thorny problems of building hardware design tools. That's what KittyCAD is for.


## The problem with selling a user interface
Expand Down
22 changes: 11 additions & 11 deletions content/posts/introducing-delouse.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: 'Introducing delouse'
title: "Introducing delouse"
excerpt: |
Introduction post on our internal rust tokio async debugging tool, delouse!
coverImage: 'documentation-assets/introducing-delouse.jpg'
date: '2024-02-12T15:00:00Z'
Introduction post on our internal rust tokio async debugging tool, delouse!
coverImage: "documentation-assets/introducing-delouse.jpg"
date: "2024-02-12T15:00:00Z"
author:
name: Paul Tagliamonte
picture: '/documentation-assets/paultag.jpg'
name: Paul Tagliamonte
picture: "/documentation-assets/paultag.jpg"
ogImage:
url: 'documentation-assets/introducing-delouse.jpg'
url: "documentation-assets/introducing-delouse.jpg"
---

At Zoo, most of our user-facing stack is written in Rust, where we’ve
Expand Down Expand Up @@ -42,7 +42,7 @@ quickly hit a dead-end when trying to generate a stack trace for all the
spawned `tokio` tasks.

Rust has robust internals for generating a stacktrace of all Rust system
threads (or, even easier – use `gdb` to attach to the process, and run
threads (or, even easier – use `gdb` to attach to the process, and run
`thread apply all bt` to generate a stack trace for all the threads from outside
the process) -- but this same level of support for `tokio` async tasks via `gdb`
does not currently exist, and is incredibly tricky to add -- I don’t think it’s
Expand Down Expand Up @@ -91,7 +91,7 @@ async fn main() -> Result<()> {

Fairly straightforward so far -- we’ll spawn a task which will loop forever
printing out "`heartbeat`" once a second, and wait on that task to finish –
never exiting. We called `delouse::init()`, which starts up a
never exiting. We called `delouse::init()`, which starts up a
[dropshot](https://crates.io/crates/dropshot) server serving requests for
`localhost` on port `7132` (not currently configurable, but will be eventually),
which has a few endpoints for debugging a misbehaving process.
Expand Down Expand Up @@ -146,13 +146,13 @@ your project’s `.cargo/config.toml` -- the `README` has some examples. More
than anything, though, the `delouse` hooks are designed to be helpful when
you’re having a bad day, and fail in a way that still attempts to be as helpful
as possible, but we’d love to find ways to make it even more helpful! Feel free
to file issues, discuss possible features or send in fixes. We’re excited to
to file issues, discuss possible features or send in fixes. We’re excited to
help save everyone some debugging time and contribute back to the ecosystem
that we've wholeheartedly adopted within Zoo!

If you’ve found this post interesting, you would fit right in at Zoo!
[Come join us](https://zoo.dev/careers), or build something great using any of
the [Zoo APIs](https://zoo.dev/docs/api) – we’re building the future of hardware
the [Zoo APIs](https://zoo.dev/docs/developer-tools/api) – we’re building the future of hardware
design by tackling the hardest infrastructure problems facing the industry
today so hardware teams can focus on designing the next big thing – not
fighting with their tools.
4 changes: 2 additions & 2 deletions content/posts/text-to-cad-blender-addon.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ ogImage:
url: 'documentation-assets/blender-addon/text-to-cad-blender-addon.jpg'
---

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.
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/ai), this add-on allows users to generate CAD models directly from text descriptions.
### What is Text-to-CAD?
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.

Expand All @@ -24,7 +24,7 @@ To use the Text-to-CAD Blender add-on, users need to have [Blender](https://www.
- **User-Friendly**: Designed for ease of use, requiring only a text prompt and a few selections to generate a model.
- **Open Source**: The Blender add-on is open source and ready for modification at your heart’s desire.

This is just the start of what you can you do with our ML-ephant and KittyCAD [APIs](https://zoo.dev/docs/api). Integrate into your own 3D modeling and CAD software of choice!
This is just the start of what you can you do with our ML-ephant and KittyCAD [APIs](https://zoo.dev/docs/developer-tools/api). Integrate into your own 3D modeling and CAD software of choice!
### Use Cases
The potential applications of the Text-to-CAD add-on are vast, touching upon multiple domains where rapid prototyping and design are essential.

Expand Down
2 changes: 1 addition & 1 deletion content/posts/turning-on-billing-for-text-to-cad.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ ogImage:

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.

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.
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/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.

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.

Expand Down
Loading