Merge 4649c75 into 66e56ec

website/docs/api.md

@@ -1,6 +1,12 @@
 ---
-title: API Reference
+title: Spock API Reference
 sidebar_position: 1
 ---
 
-Landing page 
+`spock` is a framework that helps manage complex parameter configurations during research and development of Python 
+applications. `spock` lets you focus on the code you need to write instead of re-implementing boilerplate code like 
+creating ArgParsers, reading configuration files, implementing traceability etc.
+
+
+These pages contain the Python API reference of `spock` including both public and private methods/classes, etc. Please 
+refer to [Quick Start](Quick-Start.md) for getting started with `spock`.

website/docs/index.md

@@ -73,8 +73,9 @@ Example `spock` usage is located [here](https://github.com/fidelity/spock/blob/m
 
 See [Releases](https://github.com/fidelity/spock/releases) for more information.
 
-#### December 13, 2021
+#### December 14, 2021
 * Refactored the backend to better handle nested dependencies (and for clarity)
+* Refactored the docs to use Docusaurus
 
 #### August 17, 2021
 * Added hyper-parameter tuning backend support for Ax via Service API

website/docusaurus.config.js

@@ -75,7 +75,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
               },
               {
                 label: 'Quick Start',
-                to: '/docs/quick-start',
+                to: 'Quick-Start',
               },
               {
                 label: 'Examples',

website/sidebars.js

@@ -163,7 +163,7 @@ module.exports = {
         'api',
         {
             type: 'category',
-            label: 'spock-api',
+            label: 'Python API',
             items: [
                 {
                     type: 'autogenerated',