Grammatical, spelling and other comments for the Documentation

docs/npm-debug.log

@@ -0,0 +1,102 @@
+0 info it worked if it ends with ok
+1 verbose cli [ '/Users/habibi/opt/anaconda3/bin/node',
+1 verbose cli   '/Users/habibi/opt/anaconda3/bin/npm',
+1 verbose cli   'install',
+1 verbose cli   '--save-dev',
+1 verbose cli   'typedoc' ]
+2 info using [email protected]
+3 info using [email protected]
+4 silly loadCurrentTree Starting
+5 silly install loadCurrentTree
+6 silly install readLocalPackageData
+7 silly fetchPackageMetaData typedoc@^0.24
+8 silly fetchNamedPackageData typedoc
+9 silly mapToRegistry name typedoc
+10 silly mapToRegistry using default registry
+11 silly mapToRegistry registry https://registry.npmjs.org/
+12 silly mapToRegistry data Result {
+12 silly mapToRegistry   raw: 'typedoc',
+12 silly mapToRegistry   scope: null,
+12 silly mapToRegistry   escapedName: 'typedoc',
+12 silly mapToRegistry   name: 'typedoc',
+12 silly mapToRegistry   rawSpec: '',
+12 silly mapToRegistry   spec: 'latest',
+12 silly mapToRegistry   type: 'tag' }
+13 silly mapToRegistry uri https://registry.npmjs.org/typedoc
+14 verbose request uri https://registry.npmjs.org/typedoc
+15 verbose request no auth needed
+16 info attempt registry request try #1 at 9:29:09 AM
+17 verbose request id 0e2e980bd9c1984f
+18 http request GET https://registry.npmjs.org/typedoc
+19 http 200 https://registry.npmjs.org/typedoc
+20 verbose headers { date: 'Mon, 13 Nov 2023 15:29:09 GMT',
+20 verbose headers   'content-type': 'application/json',
+20 verbose headers   'transfer-encoding': 'chunked',
+20 verbose headers   connection: 'keep-alive',
+20 verbose headers   'cf-ray': '82580c72282b26c7-MSP',
+20 verbose headers   'cf-cache-status': 'REVALIDATED',
+20 verbose headers   'access-control-allow-origin': '*',
+20 verbose headers   'cache-control': 'public, max-age=300',
+20 verbose headers   etag: 'W/"952df8082b08006d67b50a24148902df"',
+20 verbose headers   'last-modified': 'Sun, 29 Oct 2023 22:49:50 GMT',
+20 verbose headers   vary: 'accept-encoding, accept',
+20 verbose headers   server: 'cloudflare',
+20 verbose headers   'content-encoding': 'gzip' }
+21 silly get cb [ 200,
+21 silly get   { date: 'Mon, 13 Nov 2023 15:29:09 GMT',
+21 silly get     'content-type': 'application/json',
+21 silly get     'transfer-encoding': 'chunked',
+21 silly get     connection: 'keep-alive',
+21 silly get     'cf-ray': '82580c72282b26c7-MSP',
+21 silly get     'cf-cache-status': 'REVALIDATED',
+21 silly get     'access-control-allow-origin': '*',
+21 silly get     'cache-control': 'public, max-age=300',
+21 silly get     etag: 'W/"952df8082b08006d67b50a24148902df"',
+21 silly get     'last-modified': 'Sun, 29 Oct 2023 22:49:50 GMT',
+21 silly get     vary: 'accept-encoding, accept',
+21 silly get     server: 'cloudflare',
+21 silly get     'content-encoding': 'gzip' } ]
+22 verbose get saving typedoc to /Users/habibi/.npm/registry.npmjs.org/typedoc/.cache.json
+23 verbose correctMkdir /Users/habibi/.npm correctMkdir not in flight; initializing
+24 verbose makeDirectory /Users/habibi/.npm creation not in flight; initializing
+25 silly makeDirectory /Users/habibi/.npm uid: 501 gid: 20
+26 silly install normalizeTree
+27 silly loadCurrentTree Finishing
+28 silly loadIdealTree Starting
+29 silly install loadIdealTree
+30 silly cloneCurrentTree Starting
+31 silly install cloneCurrentTreeToIdealTree
+32 silly cloneCurrentTree Finishing
+33 silly loadShrinkwrap Starting
+34 silly install loadShrinkwrap
+35 silly loadShrinkwrap Finishing
+36 silly loadAllDepsIntoIdealTree Starting
+37 silly install loadAllDepsIntoIdealTree
+38 silly rollbackFailedOptional Starting
+39 silly rollbackFailedOptional Finishing
+40 silly runTopLevelLifecycles Finishing
+41 silly install printInstalled
+42 verbose stack Error: Unsupported engine for [email protected]: wanted: {"node":">= 14.14"} (current: {"node":"6.13.1","npm":"3.10.10"})
+42 verbose stack     at checkEngine (/Users/habibi/opt/anaconda3/lib/node_modules/npm/node_modules/npm-install-checks/index.js:13:14)
+42 verbose stack     at module.exports.isInstallable (/Users/habibi/opt/anaconda3/lib/node_modules/npm/lib/install/validate-args.js:38:3)
+42 verbose stack     at Array.<anonymous> (/Users/habibi/opt/anaconda3/lib/node_modules/npm/node_modules/slide/lib/bind-actor.js:15:8)
+42 verbose stack     at LOOP (/Users/habibi/opt/anaconda3/lib/node_modules/npm/node_modules/slide/lib/chain.js:15:14)
+42 verbose stack     at /Users/habibi/opt/anaconda3/lib/node_modules/npm/node_modules/slide/lib/chain.js:18:7
+42 verbose stack     at checkSelf (/Users/habibi/opt/anaconda3/lib/node_modules/npm/lib/install/validate-args.js:46:72)
+42 verbose stack     at Array.<anonymous> (/Users/habibi/opt/anaconda3/lib/node_modules/npm/node_modules/slide/lib/bind-actor.js:15:8)
+42 verbose stack     at LOOP (/Users/habibi/opt/anaconda3/lib/node_modules/npm/node_modules/slide/lib/chain.js:15:14)
+42 verbose stack     at chain (/Users/habibi/opt/anaconda3/lib/node_modules/npm/node_modules/slide/lib/chain.js:20:5)
+42 verbose stack     at /Users/habibi/opt/anaconda3/lib/node_modules/npm/lib/install/validate-args.js:16:5
+43 verbose pkgid [email protected]
+44 verbose cwd /Users/habibi/chemiscope-1/docs
+45 error Darwin 23.1.0
+46 error argv "/Users/habibi/opt/anaconda3/bin/node" "/Users/habibi/opt/anaconda3/bin/npm" "install" "--save-dev" "typedoc"
+47 error node v6.13.1
+48 error npm  v3.10.10
+49 error code ENOTSUP
+50 error notsup Unsupported engine for [email protected]: wanted: {"node":">= 14.14"} (current: {"node":"6.13.1","npm":"3.10.10"})
+51 error notsup Not compatible with your version of node/npm: [email protected]
+52 error notsup Not compatible with your version of node/npm: [email protected]
+52 error notsup Required: {"node":">= 14.14"}
+52 error notsup Actual:   {"npm":"3.10.10","node":"6.13.1"}
+53 verbose exit [ 1, true ]

docs/src/embedding.rst

@@ -2,7 +2,7 @@ Chemiscope as a library
 =======================
 
 It is possible to use chemiscope as a software library when writing your own
-web-based interface. This page document how to get the library and give a few
+web-based interface. This page documents how to get the library and provides a few
 usage examples.
 
 .. note::
@@ -95,7 +95,7 @@ And import the library inside your own code using
 
     const Chemiscope = require("chemiscope");
 
-If your are using TypeScript, definition files are also provided with the npm
+If you are using TypeScript, definition files are also provided with the npm
 package, and should give you auto-completion, inline documentation and interface
 checking.