Skip to content

Update KCL docs #813

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

Merged
jacebrowning merged 1 commit into from
Apr 9, 2026
Merged

Update KCL docs #813

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions content/pages/docs/kcl-lang/settings/project.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ base_unit = "in"

## Available Settings

### cloud




### settings


Expand Down
2 changes: 0 additions & 2 deletions content/pages/docs/kcl-std/consts/std-solver-ORIGIN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ excerpt: "The origin point in a sketch."
layout: manual
---

**WARNING:** This constant is experimental and may change or be removed.

The origin point in a sketch.

```kcl
Expand Down
2 changes: 0 additions & 2 deletions content/pages/docs/kcl-std/functions/std-helix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,6 @@ helix(
![Rendered example of helix 3](/kcl-test-outputs/serial_test_example_fn_std-helix3.png)

```kcl
@settings(experimentalFeatures = allow)

// Demonstrate building a helix where the central axis is a line defined in a sketch block.
// First, here's the sketch block with a line:
sketch002 = sketch(on = XZ) {
Expand Down
2 changes: 0 additions & 2 deletions content/pages/docs/kcl-std/functions/std-hole-hole.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,6 @@ bigCube
</model-viewer>
```kcl
@settings(experimentalFeatures = allow)
blockProfile = sketch(on = XY) {
edge1 = line(start = [var 0mm, var 0mm], end = [var 8mm, var 0mm])
edge2 = line(start = [var 8mm, var 0mm], end = [var 8mm, var 6mm])
Expand Down
2 changes: 0 additions & 2 deletions content/pages/docs/kcl-std/functions/std-hole-holes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,6 @@ hole001 = hole::holes(
</model-viewer>
```kcl
@settings(experimentalFeatures = allow)
blockProfile = sketch(on = XY) {
edge1 = line(start = [var 0mm, var 0mm], end = [var 10mm, var 0mm])
edge2 = line(start = [var 10mm, var 0mm], end = [var 10mm, var 6mm])
Expand Down
4 changes: 0 additions & 4 deletions content/pages/docs/kcl-std/functions/std-sketch-extrude.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -509,8 +509,6 @@ extrude(closedProfile, length = 5, bodyType = SURFACE)
</model-viewer>

```kcl
@settings(experimentalFeatures = allow)

profile = sketch(on = XY) {
edge1 = line(start = [var 0mm, var 0mm], end = [var 5mm, var 0mm])
edge2 = line(start = [var 5mm, var 0mm], end = [var 5mm, var 3mm])
Expand Down Expand Up @@ -545,8 +543,6 @@ solid = extrude(region(point = [2mm, 1mm], sketch = profile), length = 5)
</model-viewer>

```kcl
@settings(experimentalFeatures = allow)

// Sketch some disconnected lines in a sketch block.
originalSketch = sketch(on = YZ) {
line1 = line(start = [var -5.33mm, var 3.69mm], end = [var -5.93mm, var -2.59mm])
Expand Down
6 changes: 0 additions & 6 deletions content/pages/docs/kcl-std/functions/std-sketch-faceOf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ excerpt: "Get the face of a solid."
layout: manual
---

**WARNING:** This function is experimental and may change or be removed.

Get the face of a solid.

```kcl
Expand All @@ -33,8 +31,6 @@ faceOf(
### Examples

```kcl
@settings(experimentalFeatures = allow)

triangle = startSketchOn(XY)
|> startProfile(at = [0, 0])
|> line(end = [2, 0])
Expand Down Expand Up @@ -66,8 +62,6 @@ sideFace = faceOf(triangle, face = side)
</model-viewer>

```kcl
@settings(experimentalFeatures = allow)

triangle = sketch(on = XY) {
line1 = line(start = [var -0.05mm, var -0.01mm], end = [var 3.88mm, var 0.81mm])
line2 = line(start = [var 3.88mm, var 0.81mm], end = [var 0.92mm, var 4.67mm])
Expand Down
2 changes: 0 additions & 2 deletions content/pages/docs/kcl-std/functions/std-sketch-getBoundedEdge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,6 @@ getBoundedEdge(
### Examples

```kcl
@settings(experimentalFeatures = allow)
sketch001 = sketch(on = YZ) {
line1 = line(start = [var 4.1mm, var -0.1mm], end = [var 5.5mm, var 0mm])
line2 = line(start = [var 5.5mm, var 0mm], end = [var 5.5mm, var 3mm])
Expand Down
6 changes: 1 addition & 5 deletions content/pages/docs/kcl-std/functions/std-sketch-loft.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,8 +244,6 @@ loft([profile001, profile002, profile003], bodyType = SURFACE)
</model-viewer>

```kcl
@settings(experimentalFeatures = allow)

lowerProfile = sketch(on = XY) {
edge1 = line(start = [var 0mm, var 0mm], end = [var 6mm, var 0mm])
edge2 = line(start = [var 6mm, var 0mm], end = [var 6mm, var 4mm])
Expand Down Expand Up @@ -291,8 +289,6 @@ lofted = loft([lowerRegion, upperRegion])

```kcl
// Demonstrates surface lofts with shapes from sketch blocks.
@settings(experimentalFeatures = allow)

// Loft a square, a circle, and another circle.
sideLen = 4
squareSketch = sketch(on = XY) {
Expand Down Expand Up @@ -336,7 +332,7 @@ shape = loft([squareRegion, circleRegion], bodyType = SURFACE)

```kcl
// Demonstrates surface lofting of segments from multiple sketch blocks.
@settings(defaultLengthUnit = mm, kclVersion = 1.0, experimentalFeatures = allow)
@settings(defaultLengthUnit = mm, kclVersion = 1.0)

sketch002 = sketch(on = XY) {
arc1 = arc(start = [var -2.02mm, var -3.05mm], end = [var 2.03mm, var -3.01mm], center = [var 0.01mm, var -3.05mm])
Expand Down
2 changes: 0 additions & 2 deletions content/pages/docs/kcl-std/functions/std-sketch-planeOf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,6 @@ startSketchOn(offsetPlane(topPlane, offset = 2))
</model-viewer>
```kcl
@settings(experimentalFeatures = allow)
baseProfile = sketch(on = XY) {
line1 = line(start = [var 0mm, var 0mm], end = [var 6mm, var 0mm])
line2 = line(start = [var 6mm, var 0mm], end = [var 6mm, var 4mm])
Expand Down
8 changes: 0 additions & 8 deletions content/pages/docs/kcl-std/functions/std-sketch-region.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ excerpt: "Create a region from closed segments."
layout: manual
---

**WARNING:** This function is experimental and may change or be removed.

Create a region from closed segments.

```kcl
Expand Down Expand Up @@ -46,8 +44,6 @@ segment.
### Examples

```kcl
@settings(experimentalFeatures = allow)

triangle = sketch(on = XY) {
line1 = line(start = [var -0.05mm, var -0.01mm], end = [var 3.88mm, var 0.81mm])
line2 = line(start = [var 3.88mm, var 0.81mm], end = [var 0.92mm, var 4.67mm])
Expand Down Expand Up @@ -79,8 +75,6 @@ extrude(r, length = 5)
</model-viewer>

```kcl
@settings(experimentalFeatures = allow)

trapezoid = sketch(on = XY) {
line1 = line(start = [var 0mm, var 0mm], end = [var 4mm, var 0mm])
line2 = line(start = [var 4mm, var 0mm], end = [var 4mm, var 3mm])
Expand Down Expand Up @@ -115,8 +109,6 @@ extrude(r, length = 3)
</model-viewer>

```kcl
@settings(experimentalFeatures = allow)

s = sketch(on = XY) {
line1 = line(start = [var -5mm, var 0mm], end = [var 5mm, var 0mm])
arc1 = arc(start = [var 5mm, var 0mm], end = [var -5mm, var 0mm], center = [var 0mm, var 6mm])
Expand Down
8 changes: 0 additions & 8 deletions content/pages/docs/kcl-std/functions/std-sketch-revolve.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,8 +440,6 @@ sketch001 = startSketchOn(XY)
</model-viewer>

```kcl
@settings(experimentalFeatures = allow)

shellProfile = sketch(on = XY) {
outerWall = line(start = [var 10mm, var 0mm], end = [var 10mm, var 5mm])
connector = line(start = [var 10mm, var 5mm], end = [var 12mm, var 7mm])
Expand Down Expand Up @@ -486,8 +484,6 @@ closedShell = revolve(
</model-viewer>

```kcl
@settings(experimentalFeatures = allow)

ringProfile = sketch(on = XZ) {
edge1 = line(start = [var 4mm, var 0mm], end = [var 7mm, var 0mm])
edge2 = line(start = [var 7mm, var 0mm], end = [var 7mm, var 4mm])
Expand Down Expand Up @@ -519,8 +515,6 @@ ring = revolve(ringRegion, axis = Y)
</model-viewer>

```kcl
@settings(experimentalFeatures = allow)

// Sketch some disconnected lines in a sketch block.
originalSketch = sketch(on = YZ) {
line1 = line(start = [var -5.33mm, var 3.69mm], end = [var -5.93mm, var -2.59mm])
Expand Down Expand Up @@ -561,8 +555,6 @@ revolve(

```kcl
// Use a solved constraint line as the axis of a revolve.
@settings(experimentalFeatures = allow)

sketch001 = sketch(on = XZ) {
line1 = line(start = [var -3.34mm, var -1.89mm], end = [var -1.62mm, var -1.89mm])
line2 = line(start = [var -1.62mm, var -1.89mm], end = [var -1.62mm, var 0.56mm])
Expand Down
2 changes: 0 additions & 2 deletions content/pages/docs/kcl-std/functions/std-sketch-startSketchOn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,8 +377,6 @@ subtract(cube001, tools = cube002)
</model-viewer>
```kcl
@settings(experimentalFeatures = allow)
baseProfile = sketch(on = XY) {
line1 = line(start = [var 0mm, var 0mm], end = [var 6mm, var 0mm])
line2 = line(start = [var 6mm, var 0mm], end = [var 6mm, var 4mm])
Expand Down
7 changes: 0 additions & 7 deletions content/pages/docs/kcl-std/functions/std-sketch-sweep.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,8 +285,6 @@ sweep(
</model-viewer>

```kcl
@settings(experimentalFeatures = allow)

profile = sketch(on = YZ) {
edge1 = line(start = [var 0mm, var 0mm], end = [var 2mm, var 0mm])
edge2 = line(start = [var 2mm, var 0mm], end = [var 2mm, var 2mm])
Expand Down Expand Up @@ -324,8 +322,6 @@ swept = sweep(profileRegion, path)
</model-viewer>

```kcl
@settings(experimentalFeatures = allow)

// Demonstrates using sweeps with segments from sketch blocks.

// Sketch a square
Expand Down Expand Up @@ -373,7 +369,6 @@ sweep(mySquare, path = sketch002.line1)

```kcl
// Demonstrates sweeping along a multi-segment path from a sketch block.
@settings(experimentalFeatures = allow)

sketch001 = sketch(on = XY) {
line1 = line(start = [var 2mm, var 2mm], end = [var 2mm, var 0mm])
Expand Down Expand Up @@ -419,8 +414,6 @@ sweep(mySquare, path)
</model-viewer>

```kcl
@settings(experimentalFeatures = allow)

// Demonstrates surface sweeps of open profiles.

// Sketch a square
Expand Down
2 changes: 0 additions & 2 deletions content/pages/docs/kcl-std/functions/std-solid-blend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,6 @@ blend([
</model-viewer>
```kcl
@settings(experimentalFeatures = allow)
sketch001 = sketch(on = YZ) {
line1 = line(start = [var 4.1mm, var -0.1mm], end = [var 5.5mm, var 0mm])
line2 = line(start = [var 5.5mm, var 0mm], end = [var 5.5mm, var 3mm])
Expand Down
2 changes: 0 additions & 2 deletions content/pages/docs/kcl-std/functions/std-solid-chamfer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,8 +160,6 @@ part001 = cube(pos = [0, 0], scale = 20)
</model-viewer>
```kcl
@settings(experimentalFeatures = allow)
baseProfile = sketch(on = XY) {
edge1 = line(start = [var 0mm, var 0mm], end = [var 6mm, var 0mm])
edge2 = line(start = [var 6mm, var 0mm], end = [var 6mm, var 4mm])
Expand Down
2 changes: 0 additions & 2 deletions content/pages/docs/kcl-std/functions/std-solid-deleteFace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,8 +144,6 @@ deleteFace(cubeSolid, faceIndices = [0, 1])
</model-viewer>
```kcl
@settings(experimentalFeatures = allow)
boxProfile = sketch(on = XY) {
edge1 = line(start = [var 0mm, var 0mm], end = [var 5mm, var 0mm])
edge2 = line(start = [var 5mm, var 0mm], end = [var 5mm, var 5mm])
Expand Down
2 changes: 0 additions & 2 deletions content/pages/docs/kcl-std/functions/std-solid-fillet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,6 @@ mountingPlate = extrude(mountingPlateSketch, length = thickness)
</model-viewer>
```kcl
@settings(experimentalFeatures = allow)
blockProfile = sketch(on = XY) {
edge1 = line(start = [var 0mm, var 0mm], end = [var 6mm, var 0mm])
edge2 = line(start = [var 6mm, var 0mm], end = [var 6mm, var 4mm])
Expand Down
2 changes: 0 additions & 2 deletions content/pages/docs/kcl-std/functions/std-solid-shell.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,8 +265,6 @@ shell([thing1, thing2], faces = [END], thickness = 5)
</model-viewer>
```kcl
@settings(experimentalFeatures = allow)
boxProfile = sketch(on = XY) {
edge1 = line(start = [var 0mm, var 0mm], end = [var 6mm, var 0mm])
edge2 = line(start = [var 6mm, var 0mm], end = [var 6mm, var 4mm])
Expand Down
4 changes: 0 additions & 4 deletions content/pages/docs/kcl-std/functions/std-solver-angle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ excerpt: "Constrain lines to meet at a given angle."
layout: manual
---

**WARNING:** This function is experimental and may change or be removed.

Constrain lines to meet at a given angle.

```kcl
Expand All @@ -25,8 +23,6 @@ solver::angle(@input: [Segment; 2])
### Examples

```kcl
@settings(experimentalFeatures = allow)

profile = sketch(on = XY) {
line1 = line(start = [var 0mm, var 0mm], end = [var 4mm, var 0mm])
line2 = line(start = [var 0mm, var 0mm], end = [var 2mm, var 3.464mm])
Expand Down
4 changes: 0 additions & 4 deletions content/pages/docs/kcl-std/functions/std-solver-arc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ excerpt: "Create a circular arc. The arc segment always sweeps counterclockwise
layout: manual
---

**WARNING:** This function is experimental and may change or be removed.

Create a circular arc. The arc segment always sweeps counterclockwise from start to end. To change direction, swap the start and end points.

```kcl
Expand Down Expand Up @@ -37,8 +35,6 @@ solver::arc(
### Examples

```kcl
@settings(experimentalFeatures = allow)

profile = sketch(on = XY) {
base = line(start = [var -5mm, var 0mm], end = [var 5mm, var 0mm])
top = arc(start = [var 5mm, var 0mm], end = [var -5mm, var 0mm], center = [var 0mm, var 5mm])
Expand Down
4 changes: 0 additions & 4 deletions content/pages/docs/kcl-std/functions/std-solver-circle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ excerpt: "Create a circle in a sketch. The circle segment always has a starting
layout: manual
---

**WARNING:** This function is experimental and may change or be removed.

Create a circle in a sketch. The circle segment always has a starting point and sweeps counterclockwise from it.

```kcl
Expand Down Expand Up @@ -35,8 +33,6 @@ solver::circle(
### Examples

```kcl
@settings(experimentalFeatures = allow)
profile = sketch(on = XY) {
circle1 = circle(start = [var 2mm, var 0mm], center = [var 0mm, var 0mm], construction = true)
edge1 = line(start = [var -3mm, var -2mm], end = [var 3mm, var -2mm])
Expand Down
4 changes: 0 additions & 4 deletions content/pages/docs/kcl-std/functions/std-solver-coincident.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ excerpt: "Constrain points, or a point and a segment to be coincident."
layout: manual
---

**WARNING:** This function is experimental and may change or be removed.

Constrain points, or a point and a segment to be coincident.

```kcl
Expand All @@ -26,8 +24,6 @@ A single [`Point2d`](/docs/kcl-std/types/std-types-Point2d) (e.g. `[1mm, 2.5mm]`
### Examples

```kcl
@settings(experimentalFeatures = allow)
profile = sketch(on = XY) {
edge1 = line(start = [var 0mm, var 0mm], end = [var 4mm, var 0mm])
edge2 = line(start = [var 4mm, var 0mm], end = [var 4mm, var 3mm])
Expand Down
4 changes: 0 additions & 4 deletions content/pages/docs/kcl-std/functions/std-solver-diameter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ excerpt: "Constrain the diameter of an arc or circle segment. Accepts a single a
layout: manual
---

**WARNING:** This function is experimental and may change or be removed.

Constrain the diameter of an arc or circle segment. Accepts a single arc or circle segment and constrains the distance from its center to its start point. Note: Diameter uses the same solver constraint as radius (distance between two points), but is stored as a separate constraint type for proper UI display.

```kcl
Expand All @@ -25,8 +23,6 @@ solver::diameter(@points: Segment)
### Examples

```kcl
@settings(experimentalFeatures = allow)

profile = sketch(on = XY) {
guide = circle(start = [var 2mm, var 0mm], center = [var 0mm, var 0mm], construction = true)
diameter(guide) == 4mm
Expand Down
Loading
Loading