Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

3 set up mkdocs documentation like in instructor aiinstructor js #11

Merged
merged 15 commits into from
May 7, 2024
Merged

3 set up mkdocs documentation like in instructor aiinstructor js #11

merged 15 commits into from
May 7, 2024

Conversation

sergiobayona
Copy link
Collaborator

@sergiobayona sergiobayona commented Apr 24, 2024 •
edited
Loading

The following docs were updated to reflect Instructor-rb:

  • docs
    • blog
      • .authors.yml
      • index.md
    • concepts
      • patching.md
      • philosophy.md
      • schema.md
    • examples
      • action_items.md
      • action_itesm.png
      • index.md
    • overrides
      • main.html
    • contributing.md
    • help.md
    • index.md
    • installation.md

@sergiobayona sergiobayona linked an issue Apr 24, 2024 that may be closed by this pull request
Set up MKDocs Documentation like in instructor-ai/instructor-js #3
Closed
@sergiobayona sergiobayona added the documentation Improvements or additions to documentation label Apr 24, 2024
@sergiobayona sergiobayona marked this pull request as draft April 24, 2024 17:14
jxnl
jxnl reviewed Apr 28, 2024
View reviewed changes
Copy link
Contributor

@jxnl jxnl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lets delete the examples and ask the community to move stuff for now, and focus on install instructions and making sure stuff is working on install

docs/examples/classification.md Outdated
@@ -0,0 +1,108 @@
# Text Classification
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: to ruby

docs/examples/content_moderation.md Outdated

2. Define a Zod schema for our content, then super refine our `message` field with `moderationValidator(client)`. This means that after `message` is computed, it will be passed to `moderationValidator()` for validation.

```ts
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: to ruby

docs/examples/query_decomposition.md Outdated

Let's define the necessary models to represent the query plan and the queries.

```ts
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: to ruby

docs/examples/validated_citations.md Outdated
@@ -0,0 +1,159 @@
# Example: Answering Questions with Validated Citations
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: to ruby

@sergiobayona sergiobayona force-pushed the 3-set-up-mkdocs-documentation-like-in-instructor-aiinstructor-js branch from 14167c3 to 9d5b298 Compare May 7, 2024 15:41
@sergiobayona sergiobayona force-pushed the 3-set-up-mkdocs-documentation-like-in-instructor-aiinstructor-js branch from 119f6d4 to 3fc1b84 Compare May 7, 2024 16:00
@sergiobayona sergiobayona marked this pull request as ready for review May 7, 2024 16:05
@sergiobayona
Copy link
Collaborator Author

@jxnl okay I left the following placeholder files in the docs/examples folder:

  • classification.md
  • content_moderation.md
  • query_decomposition.md
  • self-correction.md
  • validated_citations.md

@sergiobayona sergiobayona merged commit 520aa3c into instructor-ai:main May 7, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jxnl jxnl jxnl left review comments

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Set up MKDocs Documentation like in instructor-ai/instructor-js
2 participants
@sergiobayona @jxnl