kittycad / litterbox Goto Github PK

View Code? Open in Web Editor NEW

1.0 1.0 0.0 400 KB

Sample scripts for using the KittyCAD API.

Home Page: https://docs.kittycad.io/tutorials

License: MIT License

Python 61.99% Go 10.89% Dockerfile 0.66% Makefile 3.50% JavaScript 2.18% Rust 20.77%

3d cad kittycad

litterbox's People

Contributors

Stargazers

Watchers

litterbox's Issues

Improve go base64

Jess had some advice for cleaning this up a little
https://kittycadworkspace.slack.com/archives/C030D6PR135/p1651056747904749

One final test issue hopefully

Release of interactive tutorial tool

The interactive tutorial is already live, it's only if there are tweaks we want before the release?

Otherwise there are some new tutorials we want before the release which may or may not use the litterbox

Adding formatting bot for js

Once there's a JS example.

Continues on from #4.

tutorial for volume endpoint for prod launch

Add seesaw obj for center of mass sample

--currentq

Bot details

Adding --currentq or --yyyyqx (i.e. --2035q3) to your issue body when creating it will add the issue to the correct quarter-project (if it exists).
Bot makes sure that all issues are either in KittyCode or another project (adding it to KittyCode while it's already in other projects will remove all of those projects, or adding it to another project while it's in KittyCode will remove KittyCode).
Bot comments any changes to projects on issues for tracability.

create sample for surface area endpoint

see mass tutorial as example impl

Originally posted by @hanbollar in https://github.com/KittyCAD/Furrture-Planning/issues/17#issuecomment-1215889254

add tags to existing samples

so people can search the samples by name // tag

so we can be a bit looser about 'sample categories'

tutorial for mass endpoint for prod launch

fill out samples page

See https://github.com/KittyCAD/docs/issues/59 for previous commentary

Skip down to this comment for the latest proposal on the samples page.

More comments about ideas / design decisions / plan in the discussion below

Immediate tasks:

Polish current samples page with syntax highlighting and general polish.
Add more samples to litterbox
Investigate Editable and non editable sections in a code editor
KittyCAD/docs#143

Add formatting bots, enforce 80char line wrapping

Since we're displaying the code on the web, we should avoiding side scrolling.

Original comment

Bots plural since probably need one for each lang.

Organise samples into tutorial folders

Everything is in the root atm, won't scale.

`output` on file conversions is deprecated

python and go are updated in #131

javascript needs to be updated

Trigger executor workflow when this repo updates

https://github.com/KittyCAD/executor/actions/workflows/docker-image-shell.yml

Jess found:
https://github.community/t/triggering-by-other-repository/16163

instead of having to manually add new tutorials to the test github action, we should just find all the python / go/ etc files

add sample for center of mass endpoint

center_of_mass

create tutorial to show off the new feature (right now we still dont hv sample tutorial separation, so can keep it simple as an item in tutorial section but just like the 'mass' one in terms of amount of description on it)

Originally posted by @hanbollar in https://github.com/KittyCAD/Furrture-Planning/issues/21#issuecomment-1215770174

docs.zoo.dev/tutorials is 404

docs.zoo.dev/docs/tutorials works though. I'm not sure if this is intentional or not.

Create js sdk

it will be it's own repo, so will transfer this issue when it's created.

Add samples directory

This will be for the new litterbox/samples page

Related to: KittyCAD/website/issues/584