docs: restructure documentation

AutoResearch · Dec 1, 2024 · 9ef7228 · 9ef7228
1 parent 898f360
commit 9ef7228
Show file tree

Hide file tree

Showing 13 changed files with 9 additions and 7 deletions.
diff --git a/...ickstart Guide/(1) First Experiment.ipynb → ...asic Tutorials/(1) First Experiment.ipynb b/...ickstart Guide/(1) First Experiment.ipynb → ...asic Tutorials/(1) First Experiment.ipynb
diff --git a/...ckstart Guide/(2) Instruction Block.ipynb → ...sic Tutorials/(2) Instruction Block.ipynb b/...ckstart Guide/(2) Instruction Block.ipynb → ...sic Tutorials/(2) Instruction Block.ipynb
diff --git a/docs/Quickstart Guide/(3) Stroop Block.ipynb → docs/Basic Tutorials/(3) Stroop Block.ipynb b/docs/Quickstart Guide/(3) Stroop Block.ipynb → docs/Basic Tutorials/(3) Stroop Block.ipynb
diff --git a/...rt Guide/(4) Responses and Feedback.ipynb → ...utorials/(4) Responses and Feedback.ipynb b/...rt Guide/(4) Responses and Feedback.ipynb → ...utorials/(4) Responses and Feedback.ipynb
diff --git a/docs/Quickstart Guide/Mastery.ipynb → docs/Basic Tutorials/Mastery.ipynb b/docs/Quickstart Guide/Mastery.ipynb → docs/Basic Tutorials/Mastery.ipynb
diff --git a/docs/Quickstart Guide/index.md → docs/Basic Tutorials/index.md b/docs/Quickstart Guide/index.md → docs/Basic Tutorials/index.md
@@ -1,4 +1,4 @@
-# Quickstart Guide
+# Basic Tutorials
 
 From Zero to Hero in 5 tutorials.
 

diff --git a/docs/Examples/AI Alignment/trolley_problem.json b/docs/Examples/AI Alignment/trolley_problem.json
diff --git a/...amples/AI Alignment/Trolley Problem.ipynb → ...orials/AI Alignment/Trolley Problem.ipynb b/...amples/AI Alignment/Trolley Problem.ipynb → ...orials/AI Alignment/Trolley Problem.ipynb
diff --git a/docs/Use Case Tutorials/AI Alignment/index.md b/docs/Use Case Tutorials/AI Alignment/index.md
@@ -0,0 +1,3 @@
+# AI Alignment
+
+SweetBean experiments can be run online or with via language models. This makes SweetBean a convenient package to collect data from real participants and compare it to data generated by language models. For example, to finetune a model on the collected data for alignment.
diff --git a/...xamples/Psychophysics/psychophysics.ipynb → ...torials/Psychophysics/psychophysics.ipynb b/...xamples/Psychophysics/psychophysics.ipynb → ...torials/Psychophysics/psychophysics.ipynb
diff --git a/docs/Examples/Psychophysics/sweetpea.ipynb → ...se Tutorials/Psychophysics/sweetpea.ipynb b/docs/Examples/Psychophysics/sweetpea.ipynb → ...se Tutorials/Psychophysics/sweetpea.ipynb
diff --git a/docs/Examples/index.md → docs/Use Case Tutorials/index.md b/docs/Examples/index.md → docs/Use Case Tutorials/index.md
@@ -1,3 +1,3 @@
-# Examples
+# Use Case Tutorials
 
 This section provides examples of experiments generated by SweetBean. This may serve as a starting point for your own experiments. 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -79,15 +79,15 @@ extra_javascript:
 
 nav:
   - Introduction: 'index.md'
-  - Quickstart Guide: Quickstart Guide/
-  - Examples: Examples/
+  - Basic Tutorials: Basic Tutorials/
+  - Use Case Tutorials: Use Case Tutorials/
   - User Guide:
       - Home: 'User Guide/index.md'
       - Overview: 'User Guide/overview.md'
       - Timeline Variables: 'User Guide/timeline_variables.md'
-      - Derived Variables: 'User Guide/function_variables.md'
+      - Function Variables: 'User Guide/function_variables.md'
       - Data Variables: 'User Guide/data_variables.md'
       - LLM Synthetic Participant: 'User Guide/llm_synthetic_participant.md'
-  - Stimuli: Stimuli/
+      - Stimuli: Stimuli/
   - Contributor Guide: Contributor Guide/
   - Code Reference: reference/  #
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# AI Alignment

		SweetBean experiments can be run online or with via language models. This makes SweetBean a convenient package to collect data from real participants and compare it to data generated by language models. For example, to finetune a model on the collected data for alignment.