jerpint commited on
Commit
1895d54
β€’
1 Parent(s): 21bb633

update readme and app markdown

Browse files
Files changed (2) hide show
  1. README.md +3 -2
  2. app.py +2 -2
README.md CHANGED
@@ -25,8 +25,9 @@ RAGTheDocs is an open-source library that allows you to **one-click deploy** ret
25
 
26
  3) Set your environment variables:
27
  * `OPENAI_API_KEY` (required): Needed for the app to work, e.g. `sk-...`
28
- * `READTHEDOCS_URL` (required): The url of the website you are interested in scraping
29
- * `READTHEDOCS_VERSION` (optional): This is important **only** if there exist multiple versions of the docs (e.g. "en/v0.2.7" or "en/latest"). If left empty, it will scrape all available versions (there can be many for open-source projects!).
 
30
 
31
  ## Features πŸš€
32
 
 
25
 
26
  3) Set your environment variables:
27
  * `OPENAI_API_KEY` (required): Needed for the app to work, e.g. `sk-...`
28
+ * `READTHEDOCS_URL` (required): The url of the website you are interested in scraping (must be built with
29
+ sphinx/readthedocs). e.g. `https://orion.readthedocs.io`
30
+ * `READTHEDOCS_VERSION` (optional): This is important if there exist multiple versions of the docs (e.g. `en/v0.2.7` or `en/latest`). If left empty, it will scrape all available versions (there can be many for open-source projects!).
31
 
32
  ## Features πŸš€
33
 
app.py CHANGED
@@ -133,8 +133,8 @@ with demo:
133
 
134
  * `OPENAI_API_KEY` (required): Needed for the app to work, e.g. `sk-...`
135
  * `READTHEDOCS_URL` (required): The url of the website you are interested in scraping (must be built with
136
- sphinx/readthedocs)
137
- * `READTHEDOCS_VERSION` (optional): This is important **only** if there exist multiple versions of the docs (e.g. "en/v0.2.7" or "en/latest"). If left empty, it will scrape all available versions (there can be many for open-source projects!).
138
 
139
  Try it out by asking a question below πŸ‘‡ about [orion](https://orion.readthedocs.io/), an open-source hyperparameter optimization library.
140
 
 
133
 
134
  * `OPENAI_API_KEY` (required): Needed for the app to work, e.g. `sk-...`
135
  * `READTHEDOCS_URL` (required): The url of the website you are interested in scraping (must be built with
136
+ sphinx/readthedocs). e.g. `https://orion.readthedocs.io`
137
+ * `READTHEDOCS_VERSION` (optional): This is important if there exist multiple versions of the docs (e.g. `en/v0.2.7` or `en/latest`). If left empty, it will scrape all available versions (there can be many for open-source projects!).
138
 
139
  Try it out by asking a question below πŸ‘‡ about [orion](https://orion.readthedocs.io/), an open-source hyperparameter optimization library.
140