From c3fb7849985f75c0ea99586b2654bcd29aaef4df Mon Sep 17 00:00:00 2001
From: Nathan Lambert <nathan@huggingface.co>
Date: Tue, 29 Aug 2023 16:30:18 -0700
Subject: [PATCH] fixes

---
 .github/workflows/build_documentation.yml    |  2 +-
 .github/workflows/build_pr_documentation.yml |  1 +
 README.md                                    | 17 +++++++++++++++++
 chapters/en/chapter0/introduction.mdx        |  3 ++-
 requirements.txt                             |  3 +++
 5 files changed, 24 insertions(+), 2 deletions(-)
 create mode 100644 requirements.txt

diff --git a/.github/workflows/build_documentation.yml b/.github/workflows/build_documentation.yml
index 4f89961..35f291c 100644
--- a/.github/workflows/build_documentation.yml
+++ b/.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 }}
diff --git a/.github/workflows/build_pr_documentation.yml b/.github/workflows/build_pr_documentation.yml
index 9e5f9ea..e405e4e 100644
--- a/.github/workflows/build_pr_documentation.yml
+++ b/.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
\ No newline at end of file
diff --git a/README.md b/README.md
index 7f49320..f6606aa 100644
--- a/README.md
+++ b/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
+```
\ No newline at end of file
diff --git a/chapters/en/chapter0/introduction.mdx b/chapters/en/chapter0/introduction.mdx
index 5846ae8..8d0d381 100644
--- a/chapters/en/chapter0/introduction.mdx
+++ b/chapters/en/chapter0/introduction.mdx
@@ -1 +1,2 @@
-# Welcome to the RLHF Handbook!
\ No newline at end of file
+# Welcome to the RLHF Handbook!
+We are going to...
\ No newline at end of file
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..cac6b3a
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,3 @@
+hf-doc-builder==0.4.0
+black==23.3.0
+watchdog==3.0.0
\ No newline at end of file