Docs additions! (#3)

* logo for JB

Signed-off-by: Mackenzie Mathis <[email protected]>

* Update StyleGuide.md

- space fix

Signed-off-by: Mackenzie Mathis <[email protected]>

* Update HowTo_JupyterBook.md

Signed-off-by: Mackenzie Mathis <[email protected]>

* Delete docs/intro

Signed-off-by: Mackenzie Mathis <[email protected]>

* Update _toc.yml

Signed-off-by: Mackenzie Mathis <[email protected]>

* Update _config.yml

Signed-off-by: Mackenzie Mathis <[email protected]>

---------

Signed-off-by: Mackenzie Mathis <[email protected]>

Author: MMathisLab

_config.yml

@@ -20,9 +20,9 @@ html:
     <div>Powered by <a href="https://jupyterbook.org/">Jupyter Book</a>.</div>
 
 repository:
-  url: https://github.com/SCENE-Collaboration/Code_and_Documentation_Guidelines #change me
+  url: https://github.com/AdaptiveMotorControlLab/WorkspaceTemplate #change me
   path_to_book: docs
   branch: main
 
 launch_buttons:
-  colab_url: "https://colab.research.google.com/github/SCENE-Collaboration/Code_and_Documentation_Guidelines/examples/yourdemo.ipynb"
+  colab_url: "https://colab.research.google.com/github.com/AdaptiveMotorControlLab/WorkspaceTemplate/examples/yourdemo.ipynb"

_toc.yml

@@ -1,5 +1,6 @@
 format: jb-book
 root: docs/StyleGuide 
+logo: docs/logo.png
 parts:
 - caption: Main Documentation
   chapters:

docs/HowTo_JupyterBook.md

@@ -1,6 +1,8 @@
 # What is Jupyterbook?
 
-https://jupyterbook.org/en/stable/intro.html
+We use JupyterBook for documentation and sharing computational notebooks. [Here](https://www.nature.com/articles/d41586-018-07196-1) is a nice article for motivation.
+
+📑 The documentation: https://jupyterbook.org/en/stable/intro.html
 
 
 ## Quick start
@@ -9,7 +11,7 @@ https://jupyterbook.org/en/stable/intro.html
 jupyter-book create --cookiecutter YourClonedRepo/
 ```
 
-### Build from the template provided
+## OR Build from the template provided in this Repo!
 
 (1) Use and adapt the two template files (_toc.yml, _config.yml) to your main code base, and be sure to keep the `docs` structure, i.e.,
 ```
@@ -26,11 +28,17 @@ jupyter-book create --cookiecutter YourClonedRepo/
 
 TL;DR in the main repo run:
 ```python
-❯ jupyter-book build .
+jupyter-book build .
 ```
 and then follow terminal prompt (check errors, etc)- viola!
 
 
+## Deployment:
+
 To then deploy the book live, see: https://jupyterbook.org/en/stable/publish/gh-pages.html#automatically-host-your-book-with-github-actions
 
-In short, you will set up a git action to deploy to a new branch (that you never merge) called `gh-pages`
+In short, Go to Settings > Pages and set up anaction to deploy to a new branch (that you never merge) called `gh-pages`:
+
+![Screen Shot 2025-06-17 at 2 20 19 PM](https://github.com/user-attachments/assets/17d13802-6543-4859-ac09-7abbd491277d)
+
+

docs/StyleGuide.md

@@ -5,7 +5,7 @@
 
 Please see our overall guide on code & project formatting [here](https://github.com/AdaptiveMotorControlLab/WorkspaceTemplate/blob/main/README.md).
 
-### Main Principles 🔨 Organize your code & data : 
+### Main Principles 🔨 Organize your code & data: 
 - For experimental and ML projects, please use [DataJoint/databases](https://www.datajoint.com/)
 - Be sure you work under a lab repo, typically called "https://github.com/AdaptiveMotorControlLab/YourName_workspace".
 - For larger projects (DLC, CEBRA, ExperimentalPipelines, you should be sure your "final" work gets into a pipeline; talk to Mackenzie about this)