Add usage notes and 'under construction' signs

mateogianolio · Sep 7, 2023 · 27deae0 · 27deae0
1 parent 0a113f4
commit 27deae0
Show file tree

Hide file tree

Showing 9 changed files with 34 additions and 13 deletions.
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -10,3 +10,6 @@ API reference
 
   classes/index
   functions/index
+
+.. tip::
+  Use the sidebar menu to navigate through the API reference.
diff --git a/docs/dev/index.rst b/docs/dev/index.rst
@@ -8,3 +8,5 @@ Development
   :caption: Development
   :hidden:
 
+.. warning::
+  The development page is currently under construction.
diff --git a/docs/index.rst b/docs/index.rst
@@ -5,6 +5,15 @@ Home
    :maxdepth: 1
    :hidden:
 
-   User guide <user/index>
+   User guide <user-guide/index>
    API reference <api/index>
    Development <dev/index>
+
+Welcome to the documentation for the linear algebra package vectorious.
+
+Useful links
+************
+
+- :doc:`user-guide/index`
+- :doc:`api/index`
+- :doc:`dev/index`
diff --git a/docs/user/basics.arrays.creation.rst → docs/user-guide/basics.arrays.creation.rst b/docs/user/basics.arrays.creation.rst → docs/user-guide/basics.arrays.creation.rst
diff --git a/docs/user/basics.rst → docs/user-guide/basics.rst b/docs/user/basics.rst → docs/user-guide/basics.rst
diff --git a/docs/user-guide/index.rst b/docs/user-guide/index.rst
@@ -0,0 +1,18 @@
+.. user-guide
+
+User guide
+======================================
+
+.. toctree::
+  :maxdepth: 2
+  :caption: User guide
+  :hidden:
+
+  installation
+  basics
+
+.. warning::
+  The user guide is currently under construction.
+
+
+The user guide is where you can learn how to install and use vectorious.
diff --git a/docs/user/installation.rst → docs/user-guide/installation.rst b/docs/user/installation.rst → docs/user-guide/installation.rst
diff --git a/docs/user/index.rst b/docs/user/index.rst
diff --git a/package.json b/package.json
@@ -19,6 +19,7 @@
     "test": "jest",
     "benchmark": "for file in $(ls src/**/*.bench.ts); do ts-node $file; done",
     "docs": "rm -rf docs/code && npx tsc --outDir docs/code && make -C docs html",
+    "docs:live": "rm -rf docs/code && npx tsc --outDir docs/code && make -C docs livehtml",
     "build:node": "esbuild --bundle src/index.ts --minify --sourcemap --platform=node --outfile=dist/index.js --external:nblas --external:nlapack",
     "build:browser": "esbuild --bundle src/index.ts --minify --sourcemap --platform=browser --global-name=v --outfile=dist/index.browser.js --external:nblas --external:nlapack",
     "build:esm": "esbuild --bundle src/index.ts --minify --sourcemap --format=esm --outfile=dist/index.esm.js --external:nblas --external:nlapack",