docs(all): V2 update docs (jscad#750)

* docs(modeling): changes to make docs and examples consistant

* docs(all): corrections to README documents

* docs(all): corrections to README document and packaging for main project

* docs(all): corrected README documentation

* docs(all): corrected README documentation

* docs(all): corrections to CONTRIBUTING documentation

* docs(all): corrections to CONTRIBUTING and README documentation

* docs(all): added CONTRIBUTE BUTTON to cli and web README

CODE_OF_CONDUCT.md

@@ -28,4 +28,4 @@ As contributors and maintainers of the JSCAD project, we pledge to respect all w
 
 We promise to extend courtesy and respect to everyone involved in this project regardless of gender, gender identity, sexual orientation, disability, age, race, ethnicity, religion, or level of experience.
 
-If you are subject to or witness unacceptable behavior, or have any other concerns, please anyone of the administrators of the JSCAD Project (See GitHub).
+If you are subject to or witness unacceptable behavior, or have any other concerns, please contact anyone of the administrators of the JSCAD Project (See GitHub).

CONTRIBUTING.md

@@ -11,21 +11,22 @@ We welcome and encourage anyone to pitch in but please take a moment to read the
 
 * We only accept bug reports and pull requests on **GitHub**.
 
-* If you have a question about how to use JSCAD, then please start a conversation at the [JSCAD User Group](https://jscad.xyz/forum). You might find the answer in the [JSCAD.org User Guide](https://openjscad.org/dokuwiki/doku.php).
+* If you have a question about how to use JSCAD, then please start a conversation at the [JSCAD User Group](https://jscad.xyz/forum). You might find the answer in the [JSCAD.org User Guide](https://www.jscad.xyz/dokuwiki/doku.php).
 
 * If you have a change or new feature in mind, please start a conversation with the [Core Developers](https://jscad.xyz/forum) and start contributing changes.
 
 ## Table of Contents
 
 - [Making Changes](#making_changes)
-- [Developing with the CLI[(#developing-with-the-cli)
-- [Developing with the WEB[(#developing-with-the-web)
+- [Developing with the CLI](#developing_with_the_cli)
+- [Developing with the WEB](#developing_with_the_web)
 - [Contributors](#contributors)
 
 ## Making Changes
 
 The contents of this repository contain several packages, all part of the JSCAD project.
-The JSCAD packages contain both the UI components as well as the library components, and often the JSCAD packages are linked together through dependencies.
+The JSCAD packages contain both the UI components as well as the library components,
+and often the JSCAD packages are linked together through dependencies.
 Therefore, we suggest that you start by creating a fork of this repository.
 This will keep your changes separate from the fast lane, and make pull requests easier.
 
@@ -69,7 +70,7 @@ git push
 Finally, you can review your changes via GitHub, and create a pull request.
 
 TIPS for successful pull requests:
-- Commit often, and comment the changes well
+- Commit often, and add comments about what changed
 - Verify that automated tests pass (see the bottom of the pull request)
 
 WOW! Thanks for the cool code.
@@ -108,15 +109,16 @@ npm test
 
 ### Custom Builds
 
-There are pre-built versions of JSCAD Web package in the 'dist' directory.
-- [standard](./dist/index.js)
-- [minimal viewer](./dist/min.js)
-- [viewer with options](./dist/options.js)
+There are pre-built versions of several JSCAD packages in the 'dist' directory.
+- [core](./packages/core/dist)
+- [modeling](./packages/modeling/dist)
+- [web](./packages/web/dist)
 
 You can rebuild these if you need a new version with your changes.
-- standard: ```npm run build-web```
-- minimal viewer: ```npm run build-min```
-- viewer with options: ```npm run build-opt```
+```
+cd package/core
+npm run build
+```
 
 ## Contributors
 

README.md

@@ -6,7 +6,7 @@
 
 There are many ways to use JSCAD:
 
-An [online version](https://openjscad.org/), [self hosteable web based ui](./packages/web), as [CLI](./packages/cli) (command-line interface) for server-side computations with Node.js, as well as an experimental [desktop app](https://github.com/jscad/jscad-desktop) or [individual Node.js packages](./packages/README.md)!!
+An [online version](https://www.jscad.xyz/), [self hosteable web based ui](./packages/web), as [CLI](./packages/cli) (command-line interface) for server-side computations with Node.js, as well as an experimental [desktop app](./packages/desktop) or [individual Node.js packages](./packages/README.md)!!
 
 This repository is a [monorepo](https://medium.com/@maoberlehner/monorepos-in-the-wild-33c6eb246cb9) (container of multiple packages and tools) maintained with [Lerna](https://lernajs.io/)
 
@@ -27,13 +27,12 @@ This repository is a [monorepo](https://medium.com/@maoberlehner/monorepos-in-th
 - [Backers](#backers)
 - [Sponsors](#sponsors)
 - [License](#license)
-- [Screenshots](#screenshots)
 - [See also](#see-also)
 
 ## Usage
 
 There are different 'flavors' of JSCAD that you can use based on your needs
-- web: online (no install) simply go to [https://openjscad.org/](https://openjscad.org/)
+- web: online (no install) simply go to [https://www.jscad.xyz/](https://www.jscad.xyz/)
 - web: self hosted: can be found [here](./packages/web)
 - cli: command line interface : can be found [here](./packages/cli)
 - desktop app: pre pre alpha work in progress can be found [here](./packages/desktop)!
@@ -42,7 +41,7 @@ There are different 'flavors' of JSCAD that you can use based on your needs
 
 ### Immediate Use (no installation)
 
-Go to *[OpenJSCAD.org](http://openjscad.org)* (Tested browsers include Chrome, Firefox, Opera, Safari)
+Go to *[OpenJSCAD.org](http://www.jscad.xyz)* (Tested browsers include Chrome, Firefox, Opera, Safari)
 
 ### Use within a Web Site (pre built files, from GitHub)
 
@@ -71,8 +70,8 @@ This will be expanded upon in the future, and is the backbone of the newer, modu
 ## Documentation
 
 - [Technical Overview and Q&A](./docs/index.md)
-- [JSCAD User and Programming Guide](https://openjscad.org/dokuwiki/doku.php?id=start)
-- [JSCAD Quick Reference](https://openjscad.org/dokuwiki/doku.php?id=jscad_quick_reference)
+- [JSCAD User and Programming Guide](https://www.jscad.xyz/dokuwiki/doku.php)
+- [JSCAD Quick Reference](https://www.jscad.xyz/dokuwiki/doku.php?id=jscad_quick_reference)
 
 ## Contributing
 
@@ -81,11 +80,11 @@ We welcome and encourage anyone to pitch in but please take a moment to read the
 
 * If you want to submit a bug report please make sure to follow the [Reporting Issues](https://github.com/jscad/OpenJSCAD.org/wiki/Reporting-Issues) guide. Bug reports are accepted as [Issues](https://github.com/jscad/OpenJSCAD.org/issues/) via GitHub.
 
-* If you want to submit a change or a patch, please read the [Contributing Guide](https://github.com/jscad/OpenJSCAD.org/blob/master/CONTRIBUTING.md) . New contributions are accepted as [Pull Requests](https://github.com/jscad/OpenJSCAD.org/pulls/) via GithHub.
+* If you want to submit a change or a patch, please read the [Contributing Guide](./CONTRIBUTING.md) . New contributions are accepted as [Pull Requests](https://github.com/jscad/OpenJSCAD.org/pulls/) via GithHub.
 
 * We only accept bug reports and pull requests on **GitHub**.
 
-* If you have a question about how to use JSCAD, then please start a conversation at the [JSCAD User Group](https://jscad.xyz/forum). You might find the answer in the [JSCAD.org User Guide](https://openjscad.org/dokuwiki/doku.php).
+* If you have a question about how to use JSCAD, then please start a conversation at the [JSCAD User Group](https://jscad.xyz/forum). You might find the answer in the [JSCAD.org User Guide](https://www.jscad.xyz/dokuwiki/doku.php).
 
 * If you have a change or new feature in mind, please start a conversation with the [Core Developers](https://jscad.xyz/forum) and start contributing changes.
 
@@ -145,26 +144,9 @@ Your logo will show up here with a link to your website.
 
 ## License
 
-[The MIT License (MIT)](https://github.com/jscad/OpenJSCAD.org/blob/master/LICENSE)
+[The MIT License (MIT)](./LICENSE)
 (unless specified otherwise)
 
-## Screenshots
-
-Simple JSCAD example ([logo.jscad](examples/logo.jscad)) [try it](http://openjscad.org/#examples/logo.jscad):
-<img src="packages/web/docs/sshot-01.png">
-
-More sophisticated JSCAD example, with functions dedicated to object generation and with interactive parameters ([gear.jscad](examples/gear.jscad)) [try it](http://openjscad.org/#examples/gear.jscad) :
-<img src="packages/web/docs/sshot-03-illu.png">
-
-Import of STL models ([frog-OwenCollins.stl](examples/frog-OwenCollins.stl)) [try it](http://openjscad.org/#examples/frog-OwenCollins.stl):
-<img src="packages/web/docs/sshot-04.png">
-
-Drag and drop a local file:
-<img src="packages/web/docs/sshot-05-illu.png">
-
-Drag and drop multiple files (Chrome and Firefox) or a folder (Chrome):
-<img src="packages/web/docs/sshot-06-illu.png">
-
 ## See Also
 
 - [OpenJsCAD](http://joostn.github.com/OpenJsCad/), starting point of JSCAD

jsdoc.json

@@ -93,7 +93,7 @@
         "id":"forum_link"
       },
       "JSCad Github": {
-        "href":"https://github.com/jscad/OpenJSCAD.org/tree/V2",
+        "href":"https://github.com/jscad/OpenJSCAD.org",
         "target":"_blank",
         "class":"menu-item",
         "id":"forum_link"

package.json

@@ -1,8 +1,8 @@
 {
   "name": "@jscad/openjscad",
-  "version": "1.6.1",
+  "version": "2.0.0-alpha.0",
   "description": "",
-  "repository": "https://github.com/Spiritdude/OpenJSCAD.org",
+  "repository": "https://github.com/jscad/OpenJSCAD.org",
   "scripts": {
     "docs": "jsdoc --configure jsdoc.json",
     "coverage": "npm run bootstrap && lerna run --concurrency 1 --stream coverage",

packages/cli/README.md

@@ -12,7 +12,7 @@ This is the Command Line Interface (CLI) package for creating designs using [Nod
 [![devDependency Status](https://david-dm.org/jscad/OpenJSCAD.org/dev-status.svg)](https://david-dm.org/jscad/OpenJSCAD.org#info=devDependencies)
 [![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lernajs.io/)
 
-[![Backers on Open Collective](https://opencollective.com/openjscad/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/openjscad/sponsors/badge.svg)](#sponsors) 
+<a href="https://opencollective.com/openjscad"><img src="https://opencollective.com/openjscad/donate/button.png?color=blue" alt="Open Collective"></a>
 
 ## Table of Contents
 
@@ -46,21 +46,21 @@ CLI (command-line interface) use
 
 ### Using the CLI
 
-Simply run ```openjscad <InputFile> <options> <OutputFile>```
+Simply run ```jscad <InputFile> <options> <OutputFile>```
 
 Examples:
 
-```openjscad example005.jscad                         # -- creates example005.stl as default```
+```jscad example005.jscad                         # -- creates example005.stl as default```
 
-```openjscad example001.jscad -o test.stl             # -- convert .jscad to .stl as test.stl```
+```jscad example001.jscad -o test.stl             # -- convert .jscad to .stl as test.stl```
 
-```openjscad frog.stl -o test.jscad                   # -- convert .stl into .jscad```
+```jscad frog.stl -o test.jscad                   # -- convert .stl into .jscad```
 
-```openjscad logo.jscad -of amf                       # -- convert logo.jscad into logo.amf```
+```jscad logo.jscad -of amf                       # -- convert logo.jscad into logo.amf```
 
 You can also provide the parameters to your script directly by passing --<paramName> <value> to the CLI.
 
-```openjscad name_plate.jscad --name "Just Me" --title "Geek" -o output.stl```
+```jscad name_plate.jscad --name "Just Me" --title "Geek" -o output.stl```
 
 ### Using with the provided examples
 
@@ -83,11 +83,11 @@ run them through the CLI
 
 ```
 % cd examples/
-% openjscad example005.jscad                         # -- creates example005.stl as default
-% openjscad example001.jscad -o test.stl
-% openjscad example001.scad -o example001scad.jscad  # -- convert .scad into .jscad
-% openjscad frog.stl -o test.jscad                   # -- convert .stl into .jscad
-% openjscad logo.jscad -of amf                       # -- convert logo.jscad into logo.amf
+% jscad example005.jscad                         # -- creates example005.stl as default
+% jscad example001.jscad -o test.stl
+% jscad example001.scad -o example001scad.jscad  # -- convert .scad into .jscad
+% jscad frog.stl -o test.jscad                   # -- convert .stl into .jscad
+% jscad logo.jscad -of amf                       # -- convert logo.jscad into logo.amf
 ```
 
 ### Using the CLI on designs created as NPM packages
@@ -102,11 +102,11 @@ See examples/module-design for such a design
 
 - then just pass the folder containing your design to the CLI
 
-```openjscad <PATH TO DESIGN FOLDER> <OPTIONS>```
+```jscad <PATH TO DESIGN FOLDER> <OPTIONS>```
 
 - or run the CLI on the main file if you know which one it is
 
-```openjscad <PATH TO DESIGN FOLDER>/index.js <OPTIONS>```
+```jscad <PATH TO DESIGN FOLDER>/index.js <OPTIONS>```
 
 > Note: when passing a folder to the CLI, it will:
 > - check if there is a package.json file in the folder and try to use its "main" property
@@ -156,8 +156,8 @@ or with this [nice presentation](https://darrenderidder.github.io/talks/ModulePa
 
 ## Documentation
 
-- [JSCAD User Guide](https://openjscad.org/dokuwiki/doku.php?id=start)
-- [JSCAD Quick Reference](https://openjscad.org/dokuwiki/doku.php?id=jscad_quick_reference)
+- [JSCAD User Guide](https://www.jscad.xyz/dokuwiki/doku.php)
+- [JSCAD Quick Reference](https://www.jscad.xyz/dokuwiki/doku.php?id=jscad_quick_reference)
 
 ## Contributing
 
@@ -166,11 +166,11 @@ We welcome and encourage anyone to pitch in but please take a moment to read the
 
 * If you want to submit a bug report please make sure to follow the [Reporting Issues](https://github.com/jscad/OpenJSCAD.org/wiki/Reporting-Issues) guide. Bug reports are accepted as [Issues](https://github.com/jscad/OpenJSCAD.org/issues/) via GitHub.
 
-* If you want to submit a change or a patch, please read the [Contributing Guide](https://github.com/jscad/OpenJSCAD.org/blob/master/CONTRIBUTING.md) . New contributions are accepted as [Pull Requests](https://github.com/jscad/OpenJSCAD.org/pulls/) via GithHub.
+* If you want to submit a change or a patch, please read the [Contributing Guide](../../CONTRIBUTING.md) . New contributions are accepted as [Pull Requests](https://github.com/jscad/OpenJSCAD.org/pulls/) via GithHub.
 
 * We only accept bug reports and pull requests on **GitHub**.
 
-* If you have a question about how to use JSCAD, then please start a conversation at the [JSCAD User Group](https://jscad.xyz/forum). You might find the answer in the [JSCAD.org User Guide](https://openjscad.org/dokuwiki/doku.php).
+* If you have a question about how to use JSCAD, then please start a conversation at the [JSCAD User Group](https://jscad.xyz/forum). You might find the answer in the [JSCAD.org User Guide](https://www.jscad.xyz/dokuwiki/doku.php).
 
 * If you have a change or new feature in mind, please start a conversation with the [Core Developers](https://jscad.xyz/forum) and start contributing changes.
 
@@ -205,5 +205,5 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
 
 ## License
 
-[The MIT License (MIT)](https://github.com/jscad/OpenJSCAD.org/blob/master/LICENSE)
+[The MIT License (MIT)](../../LICENSE)
 (unless specified otherwise)

packages/cli/package.json

@@ -9,7 +9,7 @@
   "scripts": {
     "coverage": "nyc --all --reporter=html --reporter=text npm test",
     "test": "ava '*.test.js' --serial --verbose --timeout 2m",
-    "postinstall": "node -e \"console.log('\\u001b[35m\\u001b[1mLove OpenJSCAD? You can now donate to our open collective:\\u001b[22m\\u001b[39m\\n > \\u001b[34mhttps://opencollective.com/openjscad/donate\\u001b[0m')\""
+    "postinstall": "node -e \"console.log('\\u001b[35m\\u001b[1mLove JSCAD? You can now donate to our open collective:\\u001b[22m\\u001b[39m\\n > \\u001b[34mhttps://opencollective.com/openjscad/donate\\u001b[0m')\""
   },
   "contributors": [
     {

packages/core/README.md

@@ -29,8 +29,8 @@ There is no UI or CLi in this package, only pieces of code ready for re-use.
 
 ## Documentation
 
-- [JSCAD User & Programming Guide](https://openjscad.org/dokuwiki/doku.php?id=start)
-- [JSCAD Quick Reference](https://openjscad.org/dokuwiki/doku.php?id=jscad_quick_reference)
+- [JSCAD User Guide](https://www.jscad.xyz/dokuwiki/doku.php)
+- [JSCAD Quick Reference](https://www.jscad.xyz/dokuwiki/doku.php?id=jscad_quick_reference)
 
 ## Contributing
 
@@ -39,11 +39,11 @@ We welcome and encourage anyone to pitch in but please take a moment to read the
 
 * If you want to submit a bug report please make sure to follow the [Reporting Issues](https://github.com/jscad/OpenJSCAD.org/wiki/Reporting-Issues) guide. Bug reports are accepted as [Issues](https://github.com/jscad/OpenJSCAD.org/issues/) via GitHub.
 
-* If you want to submit a change or a patch, please read the [Contributing Guide](https://github.com/jscad/OpenJSCAD.org/blob/master/CONTRIBUTING.md) . New contributions are accepted as [Pull Requests](https://github.com/jscad/OpenJSCAD.org/pulls/) via GithHub.
+* If you want to submit a change or a patch, please read the [Contributing Guide](../../CONTRIBUTING.md) . New contributions are accepted as [Pull Requests](https://github.com/jscad/OpenJSCAD.org/pulls/) via GithHub.
 
 * We only accept bug reports and pull requests on **GitHub**.
 
-* If you have a question about how to use JSCAD, then please start a conversation at the [JSCAD User Group](https://jscad.xyz/forum). You might find the answer in the [JSCAD.org User Guide](https://openjscad.org/dokuwiki/doku.php).
+* If you have a question about how to use JSCAD, then please start a conversation at the [JSCAD User Group](https://jscad.xyz/forum). You might find the answer in the [JSCAD User Guide](https://www.jscad.xyz/dokuwiki/doku.php).
 
 * If you have a change or new feature in mind, please start a conversation with the [Core Developers](https://jscad.xyz/forum) and start contributing changes.
 
@@ -57,5 +57,5 @@ See for more details
 
 ## License
 
-[The MIT License (MIT)](https://github.com/jscad/OpenJSCAD.org/blob/master/LICENSE)
+[The MIT License (MIT)](../../LICENSE)
 (unless specified otherwise)

packages/examples/README.md

@@ -26,8 +26,8 @@ Install this package if you need access to the various examples.
 
 ## Documentation
 
-- [JSCAD User & Programming Guide](https://openjscad.org/dokuwiki/doku.php?id=start)
-- [JSCAD Quick Reference](https://openjscad.org/dokuwiki/doku.php?id=jscad_quick_reference)
+- [JSCAD User Guide](https://www.jscad.xyz/dokuwiki/doku.php)
+- [JSCAD Quick Reference](https://www.jscad.xyz/dokuwiki/doku.php?id=jscad_quick_reference)
 
 ## Contributing
 
@@ -36,11 +36,11 @@ We welcome and encourage anyone to pitch in but please take a moment to read the
 
 * If you want to submit a bug report please make sure to follow the [Reporting Issues](https://github.com/jscad/OpenJSCAD.org/wiki/Reporting-Issues) guide. Bug reports are accepted as [Issues](https://github.com/jscad/OpenJSCAD.org/issues/) via GitHub.
 
-* If you want to submit a change or a patch, please read the [Contributing Guide](https://github.com/jscad/OpenJSCAD.org/blob/master/CONTRIBUTING.md) . New contributions are accepted as [Pull Requests](https://github.com/jscad/OpenJSCAD.org/pulls/) via GithHub.
+* If you want to submit a change or a patch, please read the [Contributing Guide](../../CONTRIBUTING.md) . New contributions are accepted as [Pull Requests](https://github.com/jscad/OpenJSCAD.org/pulls/) via GithHub.
 
 * We only accept bug reports and pull requests on **GitHub**.
 
-* If you have a question about how to use JSCAD, then please start a conversation at the [JSCAD User Group](https://jscad.xyz/forum). You might find the answer in the [JSCAD.org User Guide](https://openjscad.org/dokuwiki/doku.php).
+* If you have a question about how to use JSCAD, then please start a conversation at the [JSCAD User Group](https://jscad.xyz/forum). You might find the answer in the [JSCAD User Guide](https://www.jscad.xyz/dokuwiki/doku.php).
 
 * If you have a change or new feature in mind, please start a conversation with the [Core Developers](https://jscad.xyz/forum) and start contributing changes.
 
@@ -55,7 +55,7 @@ to discuss with other user and developers.
 
 ## License
 
-[The MIT License (MIT)](https://github.com/jscad/OpenJSCAD.org/blob/master/LICENSE)
+[The MIT License (MIT)](../../LICENSE)
 (unless specified otherwise)
 
 Some content released under different licence: