fixes

.github/workflows/build_documentation.yml

@@ -13,7 +13,7 @@ jobs:
       package: rlhf-handbook
 #      package_name: rlhf-handbook # commented from audio-course
       path_to_docs: rlhf-handbook/chapters/
-#      additional_args: --not_python_module
+      additional_args: --not_python_module
       languages: en
     secrets:
       token: ${{ secrets.HUGGINGFACE_PUSH }}

.github/workflows/build_pr_documentation.yml

@@ -14,4 +14,5 @@ jobs:
       commit_sha: ${{ github.event.pull_request.head.sha }}
       pr_number: ${{ github.event.number }}
       package: rlhf-handbook
+      additional_args: --not_python_module
       languages: en

README.md

@@ -1,3 +1,20 @@
 # The RLHF Handbook
 
 Robust recipes for RLHF
+
+## Developing
+To view this locally, run the following (need to point to a specific language if previewing only one section, preview/`build_doc` does not use the `--language` flag):
+```shell
+doc-builder preview rlhf-handbook {docs_dir} --not_python_module
+```
+Example `docs_dir` is `~/Documents/HuggingFace/dev/rlhf-handbook/chapters/en`
+
+## Installation
+Create a new conda environment with:
+```shell
+conda create -n rlhf-handbook python=3.10
+```
+Install the limited requirements with
+```shell
+pip install -r requirements.txt
+```

chapters/en/chapter0/introduction.mdx

@@ -1 +1,2 @@
-# Welcome to the RLHF Handbook!
+# Welcome to the RLHF Handbook!
+We are going to...

requirements.txt

@@ -0,0 +1,3 @@
+hf-doc-builder==0.4.0
+black==23.3.0
+watchdog==3.0.0