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

Repackage documentation and apply poetry updates #146

Merged
merged 8 commits into from
May 1, 2024

Conversation

tylerhutcherson
Copy link
Collaborator

Improves VL documentation with new Redis logos, poetry scripting, poetry docs dependencies, and also adds new reranking user guide.

@tylerhutcherson tylerhutcherson added the documentation Improvements or additions to documentation label May 1, 2024
@tylerhutcherson tylerhutcherson requested review from bsbodden and rbs333 May 1, 2024 16:42
@codecov-commenter
Copy link

codecov-commenter commented May 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.60%. Comparing base (4cd53d0) to head (4891845).

❗ Current head 4891845 differs from pull request most recent head 81ee258. Consider uploading reports for the commit 81ee258 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #146   +/-   ##
=======================================
  Coverage   88.60%   88.60%           
=======================================
  Files          29       29           
  Lines        1667     1667           
=======================================
  Hits         1477     1477           
  Misses        190      190           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@bsbodden bsbodden left a comment

Choose a reason for hiding this comment

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

LGTM just left a small question on the html files numbering

Copy link
Collaborator

Choose a reason for hiding this comment

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

Any reason the numbers on the html pages are not in order - top to bottom?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

no reason besides not wanting to commit thousands of lines to rename haha. They were initially ordered a certain way and the custom side bar was added to allow us to dynamically change the sidebar without re committing the files themselves essentially -- probably don't need numbers on the files tbh

Copy link
Collaborator

Choose a reason for hiding this comment

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

new brand icons I assume?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yep

rbs333
rbs333 previously approved these changes May 1, 2024
Copy link
Collaborator

@rbs333 rbs333 left a comment

Choose a reason for hiding this comment

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

LGTM

CONTRIBUTING.md Outdated Show resolved Hide resolved
@tylerhutcherson tylerhutcherson merged commit 7faaf4e into main May 1, 2024
18 of 20 checks passed
@tylerhutcherson tylerhutcherson deleted the docs-updates-0.2.x branch May 1, 2024 18:05
justin-cechmanek pushed a commit that referenced this pull request May 6, 2024
Improves VL documentation with new Redis logos, poetry scripting, poetry
docs dependencies, and also adds new reranking user guide.
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants