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

Update Readme #1786

Merged
merged 5 commits into from
Jan 9, 2025
Merged

Update Readme #1786

merged 5 commits into from
Jan 9, 2025

Conversation

NolanTrem
Copy link
Collaborator

@NolanTrem NolanTrem commented Jan 9, 2025

Important

Update README.md with new sections, installation instructions, and reorganized resources for R2R.

  • Content Updates:
    • Added sections for "SciPhi Cloud" and "Self Hosting" with installation instructions.
    • Updated key features to include support for over 26 file types and enhanced descriptions for Hybrid Search and Knowledge Graphs.
    • Reorganized "Resources and Cookbooks" section with updated links and descriptions.
  • Links and References:
    • Added links to "Self Hosting Installation" and "API & SDKs".
    • Updated links for existing features and resources to reflect new documentation structure.

This description was created by Ellipsis for 7aaeee9. It will automatically update as commits are pushed.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Reviewed everything up to 2c4d4a2 in 46 seconds

More details
  • Looked at 145 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 7 drafted comments based on config settings.
1. py/README.md:41
  • Draft comment:
    The link for 'Multimodal Ingestion' is incorrect. It should be updated to point to the correct documentation page.
  • Reason this comment was not posted:
    Comment looked like it was already resolved.
2. py/README.md:42
  • Draft comment:
    The link for 'Hybrid Search' is incorrect. It should be updated to point to the correct documentation page.
  • Reason this comment was not posted:
    Comment looked like it was already resolved.
3. py/README.md:43
  • Draft comment:
    The link for 'Knowledge Graphs' is incorrect. It should be updated to point to the correct documentation page.
  • Reason this comment was not posted:
    Comment looked like it was already resolved.
4. py/README.md:44
  • Draft comment:
    The link for 'User Management' is incorrect. It should be updated to point to the correct documentation page.
  • Reason this comment was not posted:
    Comment looked like it was already resolved.
5. py/README.md:45
  • Draft comment:
    The link for 'Observability' is incorrect. It should be updated to point to the correct documentation page.
  • Reason this comment was not posted:
    Comment looked like it was already resolved.
6. py/README.md:46
  • Draft comment:
    The link for 'Configuration' is incorrect. It should be updated to point to the correct documentation page.
  • Reason this comment was not posted:
    Comment looked like it was already resolved.
7. py/README.md:47
  • Draft comment:
    The link for 'Dashboard' is incorrect. It should be updated to point to the correct documentation page.
  • Reason this comment was not posted:
    Comment looked like it was already resolved.

Workflow ID: wflow_Nr0s90unL8wit5pO


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Incremental review on ca6b18c in 8 seconds

More details
  • Looked at 19 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. py/README.md:100
  • Draft comment:
# Contributing
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The change from a single '#' to '##' for the 'Contributing' section header is inconsistent with the rest of the document's structure, where top-level sections use a single '#'.

Workflow ID: wflow_8PTK0Zh49yIzg8uc


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Incremental review on 583a9a7 in 9 seconds

More details
  • Looked at 32 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. py/README.md:1
  • Draft comment:
    The badges section was removed and then re-added without any changes. Consider removing the redundant deletion and re-addition to keep the commit clean.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The badges section was removed and then re-added without any changes. This is redundant and unnecessary.

Workflow ID: wflow_QkpnJolMP4z0vOwi


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Incremental review on 7354c2b in 8 seconds

More details
  • Looked at 20 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. py/README.md:22
  • Draft comment:
    The <br /> tag here is unnecessary and inconsistent with the removal of a similar tag later. Consider removing it for consistency.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The added <br /> tag is unnecessary and inconsistent with the removal of a similar tag later in the file.

Workflow ID: wflow_Kl8dg93PALYXvILS


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Incremental review on 7aaeee9 in 12 seconds

More details
  • Looked at 18 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. py/README.md:51
  • Draft comment:
    Redundant "SciPhi Cloud" link removed, improving readability. No issues found.
  • Reason this comment was not posted:
    Confidence changes required: 0%
    The PR description mentions adding sections for "SciPhi Cloud" and "Self Hosting" with installation instructions. The change in the diff is consistent with this description, but the removal of the redundant "SciPhi Cloud" link is not explicitly mentioned. This change is logical and improves the readability of the README.

Workflow ID: wflow_UyIONuTTc7F5kLoC


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@NolanTrem NolanTrem merged commit 5fe2b28 into main Jan 9, 2025
14 checks passed
@NolanTrem NolanTrem deleted the Nolan/Readme branch January 9, 2025 01:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant