Merge pull request #65 from crucialfelix/feature/docs

Feature: docs
crucialfelix · Nov 15, 2019 · c953b43 · c953b43
2 parents ab95926 + 1b4bf8e
commit c953b43
Show file tree

Hide file tree

Showing 251 changed files with 66,946 additions and 1,869 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -25,9 +25,18 @@ module.exports = {
         args: "none",
       },
     ],
+    "@typescript-eslint/no-var-requires": [0],
 
     // indent: ["error", 2]
     // Place to specify ESLint rules. Can be used to overwrite rules specified from the extended configs
     // e.g. "@typescript-eslint/explicit-function-return-type": "off",
   },
+  overrides: [
+    {
+      files: ["*.js"],
+      rules: {
+        "@typescript-eslint/explicit-function-return-type": "off",
+      },
+    },
+  ],
 };
diff --git a/.gitignore b/.gitignore
@@ -3,10 +3,10 @@ lib
 coverage
 .node-version
 .tags1
-docs/_site
-documentation.yml
 node_modules
 lerna-debug.log
 tsconfig.tsbuildinfo
 .vscode
-*.off
+*.off
+docs/src/packages/**/api.json
+packages/**/typedoc.json
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 
 The JavaScript client library for SuperCollider.
 
-SuperCollider is an environment and programming language for real time audio synthesis and algorithmic composition. It provides an interpreted object-oriented language which functions as a network client to a state of the art, realtime sound synthesis server.
+SuperCollider is an environment and programming language for real-time audio synthesis and algorithmic composition. It provides an interpreted object-oriented language which functions as a network client to a state of the art, realtime sound synthesis server.
 
 This library provides functionality for working with:
 
@@ -73,7 +73,7 @@ sc.server.boot().then((server) => {
   let def = server.loadSynthDef('formant', './formant.scd');
 
   // Create group at the root
-  let group = server.group();
+  let group = server.group()
 
   let freqSpec = {
     minval: 100,

diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/Gemfile b/docs/Gemfile
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock