Update read me to reflect openscad and cadquery changes

Resolves #336.

README.md

@@ -4,15 +4,14 @@
 
 <!-- [![Netlify Status](https://api.netlify.com/api/v1/badges/77f37543-e54a-4723-8136-157c0221ec27/deploy-status)](https://app.netlify.com/sites/cadhubxyz/deploys) -->
 
-Let's help Code-CAD reach its [full potential!](https://cadhub.xyz) We're making a ~~cad~~hub for the Code-CAD community, think of it as model-repository crossed with a live editor. We have an integration with the excellent [cascadeStudio](https://zalo.github.io/CascadeStudio/) with [more coming soon](https://github.com/Irev-Dev/curated-code-cad).
+Let's help Code-CAD reach its [full potential!](https://cadhub.xyz) We're making a ~~cad~~hub for the Code-CAD community, think of it as model-repository crossed with a live editor. We have integrations in progress for [OpenSCAD](https://cadhub.xyz/dev-ide/openScad) and [CadQuery](https://cadhub.xyz/dev-ide/cadQuery) with [more coming soon](https://github.com/Irev-Dev/curated-code-cad).
 
 If you want to be involved in anyway, checkout the [Road Map](https://github.com/Irev-Dev/cadhub/discussions/212) and get in touch via, [twitter](https://twitter.com/IrevDev), [discord](https://discord.gg/SD7zFRNjGH) or [discussions](https://github.com/Irev-Dev/cadhub/discussions).
 
 <img src="https://raw.githubusercontent.com/Irev-Dev/repo-images/main/images/fullcadhubshot.jpg">
 
-<img src="https://raw.githubusercontent.com/Irev-Dev/repo-images/main/images/Part%20IDE%20-%20export%20expand%20state.jpg">
 
-## Getting Started
+## Getting your dev environment setup
 
 Because we're integrating cascadeStudio, this is done some what crudely for the time being, so you'll need to clone the repo with submodules.
 
@@ -73,6 +72,13 @@ We're using tailwind utility classes so please try and use them as much as possi
 
 In progress, though can be [seen on Figma](https://www.figma.com/file/VUh53RdncjZ7NuFYj0RGB9/CadHub?node-id=0%3A1)
 
-<img src="https://raw.githubusercontent.com/Irev-Dev/repo-images/main/images/Part%20Page(1).jpg">
+## Integrations
+The OpenSCAD and CadQuery integrations work by leveraging each of their cli tools in a docker image. It's currently deployed to AWS and can be found [here](https://github.com/Irev-Dev/cadhub/tree/main/app/api/src/docker).
 
-<img src="https://raw.githubusercontent.com/Irev-Dev/repo-images/main/images/User%20Page%20Edit.jpg">
+## Docs
+Docs are hosted at [learn.cadhub.xyz](http://learn.cadhub.xyz/). It includes a OpenSCAD tutorial at this point, and more is coming. The docs can be found in this repo at [docs](https://github.com/Irev-Dev/cadhub/tree/main/docs)
+
+
+## Who is CadHub
+
+[Kurt](https://github.com/Irev-Dev) and [Frank](https://github.com/franknoirot) make up the Core-team and [Jeremy](https://github.com/jmwright) is a major contributor. Plus a number smaller contributors.

app/web/src/helpers/hooks/useIdeState.js

@@ -13,6 +13,7 @@ const initCodeMap = {
 
 // ^ first comment is used for download title (i.e "involute-donut.stl")
 
+// Follow the OpenSCAD tutorial: https://learn.cadhub.xyz/docs/
 
 radius=3;
 color(c="DarkGoldenrod")rotate_extrude()translate([20,0])circle(d=30);
@@ -24,6 +25,8 @@ color(c="hotpink")rotate_extrude()translate([20,0])offset(radius)offset(-radius)
 
 # ^ first comment is used for download title (i.e. "demo-shaft-coupler.stl")
 
+# CadQuery docs: https://cadquery.readthedocs.io/
+
 import cadquery as cq
 from cadquery import exporters
 

docs/README.md

@@ -1,6 +1,8 @@
-# Website
+# CadHub Docs
 
-This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
+Our docs are built using [Docusaurus 2](https://v2.docusaurus.io/).
+
+The docs also contains a blog, if you have a good idea for a blog post that's Code-CAD relate, please pitch it to us.
 
 ## Installation
 
@@ -15,6 +17,9 @@ yarn start
 ```
 
 This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
+Note there is a [bug](https://github.com/facebook/docusaurus/issues/4588) in the ideal-image plugin that means images are blurry in dev with a huge margin below each one. annoyingly enough the Github issue has been label as a feature not a bug.
+
+To see the images properly in dev run `yarn build && yarn serve` instead, you'll have to run this each change.
 
 ## Build
 
@@ -24,10 +29,4 @@ yarn build
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service.
 
-## Deployment
 
-```console
-GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
-```
-
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.