doc: clean up docs

instructor-ai · May 23, 2024 · 733af61 · 733af61
1 parent 4b59dc6
commit 733af61
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 16 deletions.
diff --git a/docs/concepts/logging.md b/docs/concepts/logging.md
@@ -0,0 +1 @@
+Work in progress, we're open to contributions
diff --git a/docs/concepts/streaming.md b/docs/concepts/streaming.md
@@ -0,0 +1 @@
+Work in progress, we're open to contributions
diff --git a/docs/concepts/tips.md b/docs/concepts/tips.md
@@ -0,0 +1 @@
+Work in progress, we're open to contributions.
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -2,9 +2,9 @@ We would love for you to contribute to `Instructor-rb`.
 
 ## Migrating Docs from Python
 
-Theres a bunch of examples in the python version, including documentation here [python docs](https://jxnl.github.io/instructor/examples/)
+Theres a bunch of examples in the python version, including documentation here [python docs](https://useinstructor.com/examples/)
 
-If you want to contribute, please check out [issues](https://github.com/instructor-ai/instructor/issues)
+If you want to contribute, please check out [issues](https://github.com/instructor-ai/instructor-rb/issues)
 
 ## Issues
 
@@ -35,13 +35,11 @@ bundle install
 2. **Environment Variables**:
 setup the OpenAI API key in your environment variables.
 
-```bash
-
-### Code Quality Tools
+**Code Quality Tools**
 
 - This project uses rubocop.
 
-### Running Tests
+**Running Tests**
 
 - Execute tests using the following command:
 
@@ -69,7 +67,7 @@ If it is not a small change, please start by [filing an issue](https://github.co
 
 ## Contributors
 
-<a href="https://github.com/jxnl/instructor/graphs/contributors">
+<a href="https://github.com/instructor-ai/instructor-rb/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=instructor-ai/instructor-rb" />
 </a>
 

diff --git a/docs/index.md b/docs/index.md
@@ -20,6 +20,13 @@ If you want to port Instructor to another language, please reach out to us on [T
 
 To check out all the tips and tricks to prompt and extract data, check out the [documentation](https://instructor-ai.github.io/instructor-rb/tips/prompting/).
 
+Installation is as simple as:
+
+```bash
+gem install intructor-rb
+```
+
+
 ```Ruby
 require 'instructor-rb'
 
@@ -65,11 +72,9 @@ The question of using Instructor is fundamentally a question of why to use zod.
 
 If you'd like to see more check out our [cookbook](examples/index.md).
 
-[Installing Instructor](installation.md) is a breeze. 
-
 ## Contributing
 
-If you want to help out, checkout some of the issues marked as `good-first-issue` or `help-wanted`. Found [here](https://github.com/instructor-ai/instructor-js/labels/good%20first%20issue). They could be anything from code improvements, a guest blog post, or a new cook book.
+If you want to help out, checkout some of the issues marked as `good-first-issue` or `help-wanted`. Found [here](https://github.com/instructor-ai/instructor-rb/labels/good%20first%20issue). They could be anything from code improvements, a guest blog post, or a new cook book.
 
 ## License
 

diff --git a/docs/installation.md b/docs/installation.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -128,7 +128,7 @@ nav:
     - Patching: 'concepts/patching.md'
     - Streaming: 'concepts/streaming.md'
     - Logging: 'concepts/logging.md'
-    - Prompting Tips: 'tips/prompting.md'
+    - Prompting Tips: 'concepts/prompting.md'
     - Philosophy: 'concepts/philosophy.md'
     - Help with Instructor: 'help.md'
     - Installation: 'installation.md'