ByoungSooPark/modeling-app
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

#7199 Fix broken links in docs (#7397)

Browse Source 
* update broken links

* update github discussion links, fmt

* update comment

---------

Co-authored-by: Jace Browning <jacebrowning@gmail.com>
This commit is contained in:
Andrew Varga
2025-06-06 17:52:56 +02:00
committed by GitHub
parent 29cf16d744
commit a1ac029333
2 changed files with 49 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/lib/getCurrentProjectFile.ts
View File

@ -105,7 +105,7 @@ export default async function getCurrentProjectFile(
// You can edit this file to add your own content. // You can edit this file to add your own content.
// But we recommend you keep the import statement as it is. // But we recommend you keep the import statement as it is.
// For more information on the import statement, see the documentation at: // For more information on the import statement, see the documentation at:
// https://zoo.dev/docs/kcl/import // https://zoo.dev/docs/kcl-lang/modules
import "${importFileName}" as ${alias}` import "${importFileName}" as ${alias}`
await fs.writeFile(kclWrapperFilePath, content) await fs.writeFile(kclWrapperFilePath, content)
} }

70
src/lib/toolbar.ts
View File

@ -103,7 +103,10 @@ export const toolbarConfig: Record<ToolbarModeName, ToolbarMode> = {
hotkey: 'S', hotkey: 'S',
description: 'Start drawing a 2D sketch', description: 'Start drawing a 2D sketch',
links: [ links: [
{ label: 'KCL docs', url: 'https://zoo.dev/docs/kcl/startSketchOn' }, {
label: 'KCL docs',
url: 'https://zoo.dev/docs/kcl-std/startSketchOn',
},
], ],
}, },
'break', 'break',
@ -119,7 +122,9 @@ export const toolbarConfig: Record<ToolbarModeName, ToolbarMode> = {
title: 'Extrude', title: 'Extrude',
hotkey: 'E', hotkey: 'E',
description: 'Pull a sketch into 3D along its normal or perpendicular.', description: 'Pull a sketch into 3D along its normal or perpendicular.',
links: [{ label: 'KCL docs', url: 'https://zoo.dev/docs/kcl/extrude' }], links: [
{ label: 'KCL docs', url: 'https://zoo.dev/docs/kcl-std/extrude' },
],
}, },
{ {
id: 'sweep', id: 'sweep',
@ -137,7 +142,7 @@ export const toolbarConfig: Record<ToolbarModeName, ToolbarMode> = {
links: [ links: [
{ {
label: 'KCL docs', label: 'KCL docs',
url: 'https://zoo.dev/docs/kcl/sweep', url: 'https://zoo.dev/docs/kcl-std/sweep',
}, },
], ],
}, },
@ -157,7 +162,7 @@ export const toolbarConfig: Record<ToolbarModeName, ToolbarMode> = {
links: [ links: [
{ {
label: 'KCL docs', label: 'KCL docs',
url: 'https://zoo.dev/docs/kcl/loft', url: 'https://zoo.dev/docs/kcl-std/loft',
}, },
], ],
}, },
@ -175,7 +180,10 @@ export const toolbarConfig: Record<ToolbarModeName, ToolbarMode> = {
description: description:
'Create a 3D body by rotating a sketch region about an axis.', 'Create a 3D body by rotating a sketch region about an axis.',
links: [ links: [
{ label: 'KCL docs', url: 'https://zoo.dev/docs/kcl/revolve' }, {
label: 'KCL docs',
url: 'https://zoo.dev/docs/kcl-std/functions/std-sketch-revolve',
},
{ {
label: 'KCL example', label: 'KCL example',
url: 'https://zoo.dev/docs/kcl-samples/ball-bearing', url: 'https://zoo.dev/docs/kcl-samples/ball-bearing',
@ -195,7 +203,12 @@ export const toolbarConfig: Record<ToolbarModeName, ToolbarMode> = {
title: 'Fillet', title: 'Fillet',
hotkey: 'F', hotkey: 'F',
description: 'Round the edges of a 3D solid.', description: 'Round the edges of a 3D solid.',
links: [{ label: 'KCL docs', url: 'https://zoo.dev/docs/kcl/fillet' }], links: [
{
label: 'KCL docs',
url: 'https://zoo.dev/docs/kcl-std/functions/std-solid-fillet',
},
],
}, },
{ {
id: 'chamfer3d', id: 'chamfer3d',
@ -216,7 +229,10 @@ export const toolbarConfig: Record<ToolbarModeName, ToolbarMode> = {
label: 'issue tracker', label: 'issue tracker',
url: 'https://github.com/KittyCAD/modeling-app/issues/6617', url: 'https://github.com/KittyCAD/modeling-app/issues/6617',
}, },
{ label: 'KCL docs', url: 'https://zoo.dev/docs/kcl/chamfer' }, {
label: 'KCL docs',
url: 'https://zoo.dev/docs/kcl-std/functions/std-solid-chamfer',
},
], ],
}, },
{ {
@ -231,7 +247,12 @@ export const toolbarConfig: Record<ToolbarModeName, ToolbarMode> = {
status: 'available', status: 'available',
title: 'Shell', title: 'Shell',
description: 'Hollow out a 3D solid.', description: 'Hollow out a 3D solid.',
links: [{ label: 'KCL docs', url: 'https://zoo.dev/docs/kcl/shell' }], links: [
{
label: 'KCL docs',
url: 'https://zoo.dev/docs/kcl-std/functions/std-solid-shell',
},
],
}, },
'break', 'break',
{ {
@ -250,8 +271,8 @@ export const toolbarConfig: Record<ToolbarModeName, ToolbarMode> = {
description: 'Combine two or more solids into a single solid.', description: 'Combine two or more solids into a single solid.',
links: [ links: [
{ {
label: 'GitHub discussion', label: 'KCL docs',
url: 'https://github.com/KittyCAD/modeling-app/discussions/509', url: 'https://zoo.dev/docs/kcl-std/union',
}, },
], ],
}, },
@ -268,8 +289,8 @@ export const toolbarConfig: Record<ToolbarModeName, ToolbarMode> = {
description: 'Subtract one solid from another.', description: 'Subtract one solid from another.',
links: [ links: [
{ {
label: 'GitHub discussion', label: 'KCL docs',
url: 'https://github.com/KittyCAD/modeling-app/discussions/510', url: 'https://zoo.dev/docs/kcl-std/subtract',
}, },
], ],
}, },
@ -286,8 +307,8 @@ export const toolbarConfig: Record<ToolbarModeName, ToolbarMode> = {
description: 'Create a solid from the intersection of two solids.', description: 'Create a solid from the intersection of two solids.',
links: [ links: [
{ {
label: 'GitHub discussion', label: 'KCL docs',
url: 'https://github.com/KittyCAD/modeling-app/discussions/511', url: 'https://zoo.dev/docs/kcl-std/intersect',
}, },
], ],
}, },
@ -313,7 +334,7 @@ export const toolbarConfig: Record<ToolbarModeName, ToolbarMode> = {
links: [ links: [
{ {
label: 'KCL docs', label: 'KCL docs',
url: 'https://zoo.dev/docs/kcl/offsetPlane', url: 'https://zoo.dev/docs/kcl-std/functions/std-offsetPlane',
}, },
], ],
}, },
@ -341,7 +362,12 @@ export const toolbarConfig: Record<ToolbarModeName, ToolbarMode> = {
status: 'available', status: 'available',
title: 'Helix', title: 'Helix',
description: 'Create a helix or spiral in 3D about an axis.', description: 'Create a helix or spiral in 3D about an axis.',
links: [{ label: 'KCL docs', url: 'https://zoo.dev/docs/kcl/helix' }], links: [
{
label: 'KCL docs',
url: 'https://zoo.dev/docs/kcl-std/functions/std-helix',
},
],
}, },
'break', 'break',
{ {
@ -360,7 +386,7 @@ export const toolbarConfig: Record<ToolbarModeName, ToolbarMode> = {
links: [ links: [
{ {
label: 'API docs', label: 'API docs',
url: 'https://zoo.dev/docs/kcl/import', url: 'https://zoo.dev/docs/kcl-lang/modules',
}, },
], ],
}, },
@ -381,7 +407,7 @@ export const toolbarConfig: Record<ToolbarModeName, ToolbarMode> = {
links: [ links: [
{ {
label: 'API docs', label: 'API docs',
url: 'https://zoo.dev/docs/kcl/translate', url: 'https://zoo.dev/docs/kcl-std/translate',
}, },
], ],
}, },
@ -399,7 +425,7 @@ export const toolbarConfig: Record<ToolbarModeName, ToolbarMode> = {
links: [ links: [
{ {
label: 'API docs', label: 'API docs',
url: 'https://zoo.dev/docs/kcl/rotate', url: 'https://zoo.dev/docs/kcl-std/rotate',
}, },
], ],
}, },
@ -417,7 +443,7 @@ export const toolbarConfig: Record<ToolbarModeName, ToolbarMode> = {
links: [ links: [
{ {
label: 'API docs', label: 'API docs',
url: 'https://zoo.dev/docs/kcl/clone', url: 'https://zoo.dev/docs/kcl-std/functions/std-clone',
}, },
], ],
}, },
@ -710,7 +736,7 @@ export const toolbarConfig: Record<ToolbarModeName, ToolbarMode> = {
links: [ links: [
{ {
label: 'KCL docs', label: 'KCL docs',
url: 'https://zoo.dev/docs/kcl/polygon', url: 'https://zoo.dev/docs/kcl-std/polygon',
}, },
], ],
}, },
@ -726,7 +752,7 @@ export const toolbarConfig: Record<ToolbarModeName, ToolbarMode> = {
links: [ links: [
{ {
label: 'KCL docs', label: 'KCL docs',
url: 'https://zoo.dev/docs/kcl/std-sketch-mirror2d', url: 'https://zoo.dev/docs/kcl-std/functions/std-transform-mirror2d',
}, },
], ],
}, },