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.

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

Cookbook reorganization #1359

Closed
wants to merge 14 commits into from
Closed

Cookbook reorganization #1359

wants to merge 14 commits into from

Conversation

sfc-gh-jreini
Copy link
Contributor

@sfc-gh-jreini sfc-gh-jreini commented Aug 19, 2024

Description

Display examples nicely in docs cookbook + update some other docs examples to display nicely

Other details good to know for developers

Please include any other details of this change useful for TruLens developers.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to
    not work as expected)
  • New Tests
  • This change includes re-generated golden test results
  • This change requires a documentation update

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@sfc-gh-jreini sfc-gh-jreini changed the title move examples into folders for models Cookbook reorganization Aug 19, 2024
@sfc-gh-jreini sfc-gh-jreini marked this pull request as ready for review August 19, 2024 17:52
@dosubot dosubot bot added the size:XXL This PR changes 1000+ lines, ignoring generated files. label Aug 19, 2024
@dosubot dosubot bot added the documentation Improvements or additions to documentation label Aug 19, 2024
@@ -0,0 +1,177 @@
# 🦙 LlamaIndex Integration
Copy link
Contributor

Choose a reason for hiding this comment

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

just curious why replace the notebooks with markdown? I thought some jupyter mkdocs extension does that for us

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Did this for these docs pages because they're not intended to be runnable notebooks anyways, and the extension does it for us but it's still kind of ugly compared to normal markdown. Perhaps there's some changes we can make to the extension to make that nicer in general, I can look into that.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Aug 20, 2024
@sfc-gh-jreini sfc-gh-jreini force-pushed the josh/cookbook_updates branch 2 times, most recently from 2ca304c to 58dc031 Compare August 20, 2024 20:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:XXL This PR changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants