kittycad / documentation Goto Github PK
View Code? Open in Web Editor NEWThe handwritten sections of the KittyCAD docs. Found a typo? make an edit :D !
License: MIT License
The handwritten sections of the KittyCAD docs. Found a typo? make an edit :D !
License: MIT License
Capturing a batch of glossary terms we need to add to the glossary while writing the new home page copy, first being "engine" or "modeling engine" or "geometry engine".
This is a term we use quite a lot that would be good to be able to link to our definition and why it's powerful compared to mesh-based approaches, particularly in generative geometry applications.
Do a full sweep of all tutorials and make sure:
Mentions of KittyCAD are switched to Zoo
Scripts in litterbox are accurate to tutorial docs
All files can be downloaded and used immediately
Javascript Beginner Tutorial
Python Beginner Tutorial
Get file metadata (mass, volume)
Get the Mass of a CAD file
Convert an OBJ file to STEP
Convert an OBJ file to STL
Advanced Onboarding (may remove this entirely)
Using the Modeling API
Finally,
onboarding
to advanced onboarding
tutorial and beginner tutorial
to beginner onboarding
tutorialWe should add Contentlayer to this repo and the website repo to get type safe content type definitions.
We'll define the schemas in here with the contentlayer.config.ts
file, then the type definitions will come along for the ride when the website pulls this repo into it, but we can still validate the content if someone happens to only have this pulled down.
The blog posts currently live within the website repo, but they should be public and have the type safety we'll get through Contentlayer after we complete #45.
Inverse of how the website's local dev works, have a yarn script that pulls the latest website codebase and runs it locally, hot refreshing when edits are made to the content.
I attempted to go through the onboarding process documented here: https://kittycad.io/docs/tutorials/onboarding. I wasn't able to complete it.
On the last step running:
python3 convert.py
I got the following:
Traceback (most recent call last):
File "/home/shane/projects/kittycad-play/convert.py", line 17, in <module>
fc = create_file_conversion_with_base64_helper.sync(
File "/home/shane/projects/kittycad-play/venv/lib/python3.10/site-packages/kittycad/api/file/create_file_conversion_with_base64_helper.py", line 25, in sync
fc = fc_sync(
File "/home/shane/projects/kittycad-play/venv/lib/python3.10/site-packages/kittycad/api/file/create_file_conversion.py", line 88, in sync
return sync_detailed(
File "/home/shane/projects/kittycad-play/venv/lib/python3.10/site-packages/kittycad/api/file/create_file_conversion.py", line 74, in sync_detailed
return _build_response(response=response)
File "/home/shane/projects/kittycad-play/venv/lib/python3.10/site-packages/kittycad/api/file/create_file_conversion.py", line 51, in _build_response
parsed=_parse_response(response=response),
File "/home/shane/projects/kittycad-play/venv/lib/python3.10/site-packages/kittycad/api/file/create_file_conversion.py", line 35, in _parse_response
response_201 = FileConversion.from_dict(response.json())
File "/home/shane/projects/kittycad-play/venv/lib/python3.10/site-packages/kittycad/models/file_conversion.py", line 137, in from_dict
status = ApiCallStatus(_status)
File "/home/shane/anaconda3/lib/python3.10/enum.py", line 385, in __call__
return cls.__new__(cls, value)
File "/home/shane/anaconda3/lib/python3.10/enum.py", line 710, in __new__
raise ve_exc
ValueError: 'completed' is not a valid ApiCallStatus
I'm running Pop_OS! 22.04.
I also found a broken link on the onboarding page. The last link at the bottom "Found a typo?" goes to https://github.com/KittyCAD/documentation/edit/main/_pages/docs/tutorials/onboarding.mdx and is a 404.
we should do something not toggle based but more tab based that makes better sense to the user like github's style with: https://docs.github.com/en/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys?platform=mac
it has tabs that auto change the content and autodetects what tab should be loaded --> obv we'll need to figure out a better visual setup since it's not that noticeable right of the bat visually, but would be a better setup than the drop downs for usability
Originally posted by @hanbollar in https://github.com/KittyCAD/PetStore/issues/99#issuecomment-1343334378
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.