change up docs format (#1711)

* change up docs format Signed-off-by: Jess Frazelle <[email protected]> * change up docs format Signed-off-by: Jess Frazelle <[email protected]> * change up docs format Signed-off-by: Jess Frazelle <[email protected]> * fix Signed-off-by: Jess Frazelle <[email protected]> * workflow to push docs Signed-off-by: Jess Frazelle <[email protected]> * fix[ Signed-off-by: Jess Frazelle <[email protected]> * initial commit Signed-off-by: Jess Frazelle <[email protected]> * fix Signed-off-by: Jess Frazelle <[email protected]> * initial commit Signed-off-by: Jess Frazelle <[email protected]> * initial commit Signed-off-by: Jess Frazelle <[email protected]> * fixes Signed-off-by: Jess Frazelle <[email protected]> * updates Signed-off-by: Jess Frazelle <[email protected]> --------- Signed-off-by: Jess Frazelle <[email protected]>
KittyCAD · Mar 13, 2024 · 4be9f70 · 4be9f70
1 parent a60bdd4
commit 4be9f70
Show file tree

Hide file tree

Showing 77 changed files with 12,727 additions and 12,351 deletions.
diff --git a/.github/workflows/generate-website-docs.yml b/.github/workflows/generate-website-docs.yml
@@ -0,0 +1,62 @@
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - .github/workflows/generate-website-docs.yml
+      - 'docs/**'
+  pull_request:
+    paths:
+      - .github/workflows/generate-website-docs.yml
+  workflow_dispatch:
+name: generate-website-docs
+concurrency:
+  group: docs-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  generate-website-docs:
+    name: generate-website-docs 
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/create-github-app-token@v1
+        id: app-token
+        with:
+          # required
+          app-id: ${{ secrets.GH_ORG_APP_ID }}
+          private-key: ${{ secrets.GH_ORG_APP_PRIVATE_KEY }}
+          owner: ${{ github.repository_owner }}
+      # Checkout the docs repo since we will want to update the files there.
+      - uses: actions/checkout@v4
+        with:
+          repository: 'kittycad/documentation'
+          path: 'documentation'
+          token: ${{ steps.app-token.outputs.token }}
+      - name: move docs to docs
+        shell: bash
+        run: |
+          mkdir -p documentation/content/pages/docs/kcl/
+          # cleanup old
+          rm -rf documentation/content/pages/docs/kcl/*.md
+          # move new
+          mv -f docs/kcl/*.md documentation/content/pages/docs/kcl/
+      - name: commit the changes in the docs repo
+        shell: bash
+        run: |
+          cd documentation
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git add .
+          git commit -am "YOYO NEW KCL DOCS!!" || exit 0
+          git fetch origin
+          git rebase origin/main || exit 0
+          export NEW_BRANCH="update-kcl-docs"
+          git checkout -b "$NEW_BRANCH"
+          git push -f origin "$NEW_BRANCH"
+          gh pr create --title "Update KCL docs" \
+              --body "Updating the generated kcl docs cc @jessfraz @franknoirot merge this" \
+              --head "$NEW_BRANCH" \
+              --base main || true
+        env:
+          GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
+
diff --git a/docs/kcl/KNOWN-ISSUES.md b/docs/kcl/KNOWN-ISSUES.md
@@ -1,4 +1,8 @@
-# Known Issues
+---
+title: "KCL Known Issues"
+excerpt: "Known issues with the KCL standard library for the Zoo Modeling App."
+layout: manual
+---
 
 The following are bugs that are not in modeling-app or kcl itself. These bugs
 once fixed in engine will just start working here with no language changes.

diff --git a/docs/kcl/abs.md b/docs/kcl/abs.md
@@ -0,0 +1,30 @@
+---
+title: "abs"
+excerpt: "Computes the absolute value of a number."
+layout: manual
+---
+
+Computes the absolute value of a number.
+
+
+
+```
+abs(num: number) -> number
+```
+
+### Examples
+
+```kcl
+const myVar = abs(-4)
+```
+
+### Arguments
+
+* `num`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+
diff --git a/docs/kcl/acos.md b/docs/kcl/acos.md
@@ -0,0 +1,30 @@
+---
+title: "acos"
+excerpt: "Computes the arccosine of a number (in radians)."
+layout: manual
+---
+
+Computes the arccosine of a number (in radians).
+
+
+
+```
+acos(num: number) -> number
+```
+
+### Examples
+
+```kcl
+const myVar = acos(0.5)
+```
+
+### Arguments
+
+* `num`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+
diff --git a/docs/kcl/angleToMatchLengthX.md b/docs/kcl/angleToMatchLengthX.md
@@ -0,0 +1,202 @@
+---
+title: "angleToMatchLengthX"
+excerpt: "Returns the angle to match the given length for x."
+layout: manual
+---
+
+Returns the angle to match the given length for x.
+
+
+
+```
+angleToMatchLengthX(segment_name: string, to: number, sketch_group: SketchGroup) -> number
+```
+
+### Examples
+
+```kcl
+const part001 = startSketchOn('XY')
+  |> startProfileAt([0, 0], %)
+  |> line({ to: [1, 3.82], tag: 'seg01' }, %)
+  |> angledLineToX([
+       -angleToMatchLengthX('seg01', 10, %),
+       5
+     ], %)
+  |> close(%)
+```
+
+### Arguments
+
+* `segment_name`: `string` (REQUIRED)
+* `to`: `number` (REQUIRED)
+* `sketch_group`: `SketchGroup` - A sketch group is a collection of paths. (REQUIRED)
+```
+{
+	// The plane id or face id of the sketch group.
+	entityId: uuid,
+	// The id of the sketch group.
+	id: uuid,
+	// What the sketch is on (can be a plane or a face).
+	on: {
+	// The id of the plane.
+	id: uuid,
+	// Origin of the plane.
+	origin: {
+	x: number,
+	y: number,
+	z: number,
+},
+	type: "plane",
+	// Type for a plane.
+	value: "XY" | "XZ" | "YZ" | "Custom",
+	// What should the plane’s X axis be?
+	xAxis: {
+	x: number,
+	y: number,
+	z: number,
+},
+	// What should the plane’s Y axis be?
+	yAxis: {
+	x: number,
+	y: number,
+	z: number,
+},
+	// The z-axis (normal).
+	zAxis: {
+	x: number,
+	y: number,
+	z: number,
+},
+} |
+{
+	// The id of the face.
+	id: uuid,
+	// The original sketch group id of the object we are sketching on.
+	sketchGroupId: uuid,
+	type: "face",
+	// The tag of the face.
+	value: string,
+	// What should the face’s X axis be?
+	xAxis: {
+	x: number,
+	y: number,
+	z: number,
+},
+	// What should the face’s Y axis be?
+	yAxis: {
+	x: number,
+	y: number,
+	z: number,
+},
+	// The z-axis (normal).
+	zAxis: {
+	x: number,
+	y: number,
+	z: number,
+},
+},
+	// The position of the sketch group.
+	position: [number, number, number],
+	// The rotation of the sketch group base plane.
+	rotation: [number, number, number, number],
+	// The starting path.
+	start: {
+	// The from point.
+	from: [number, number],
+	// The name of the path.
+	name: string,
+	// The to point.
+	to: [number, number],
+},
+	// The paths in the sketch group.
+	value: [{
+	// The from point.
+	from: [number, number],
+	// The name of the path.
+	name: string,
+	// The to point.
+	to: [number, number],
+	type: "ToPoint",
+} |
+{
+	// arc's direction
+	ccw: string,
+	// the arc's center
+	center: [number, number],
+	// The from point.
+	from: [number, number],
+	// The name of the path.
+	name: string,
+	// The to point.
+	to: [number, number],
+	type: "TangentialArcTo",
+} |
+{
+	// The from point.
+	from: [number, number],
+	// The name of the path.
+	name: string,
+	// The to point.
+	to: [number, number],
+	type: "TangentialArc",
+} |
+{
+	// The from point.
+	from: [number, number],
+	// The name of the path.
+	name: string,
+	// The to point.
+	to: [number, number],
+	type: "Horizontal",
+	// The x coordinate.
+	x: number,
+} |
+{
+	// The from point.
+	from: [number, number],
+	// The name of the path.
+	name: string,
+	// The to point.
+	to: [number, number],
+	type: "AngledLineTo",
+	// The x coordinate.
+	x: number,
+	// The y coordinate.
+	y: number,
+} |
+{
+	// The from point.
+	from: [number, number],
+	// The name of the path.
+	name: string,
+	// The to point.
+	to: [number, number],
+	type: "Base",
+}],
+	// The x-axis of the sketch group base plane in the 3D space
+	xAxis: {
+	x: number,
+	y: number,
+	z: number,
+},
+	// The y-axis of the sketch group base plane in the 3D space
+	yAxis: {
+	x: number,
+	y: number,
+	z: number,
+},
+	// The z-axis of the sketch group base plane in the 3D space
+	zAxis: {
+	x: number,
+	y: number,
+	z: number,
+},
+}
+```
+
+### Returns
+
+`number`
+
+
+