kittycad / documentation Goto Github PK

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.

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

We 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.

• Get file metadata (mass, volume)
• Convert an OBJ file to STEP
• Convert an OBJ file to STL
• Onboarding
• Onboarding on-page code example (not pulled from litterbox)

• recommendations on the tutorial homepage based on most recent added - and if they havent done any api calls yet, we make sure the beginner and adv onboarding tutorials are at the front
• remove automatic alphabetical ordering for the left side just for this page and allow for manually ordered and groupings with the two onboarding tutorials grouped in the onboarding section at the top
• change titling for onboarding to advanced onboarding tutorial and beginner tutorial to beginner onboarding tutorial

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".

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.