Migrate docs from Fern to Gitub #2215
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Changes requested ❌
Reviewed everything up to b34c6ef in 5 minutes and 46 seconds. Click for details.
- Reviewed
4544lines of code in31files - Skipped
0files when reviewing. - Skipped posting
13draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. docs/cookbooks/custom-tools.md:44
- Draft comment:
The sample tool code uses 'some_method(input_parameter)' and references 'web_response' without definition. Consider providing a stub, comment, or proper implementation for clarity. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% This is a template/example section meant to show the basic structure. The undefined variables are placeholders that developers would replace with their own implementation. The comment suggests adding a TODO, but that might make the template more cluttered without adding value. The complete working example that follows shows how to properly implement a tool. The comment does identify a potential source of confusion for new developers. Template code with undefined variables could be unclear. However, this is clearly marked as template code, and the full working example that follows provides clear guidance on proper implementation. Adding TODOs or stubs would make the template more complex without benefit. The comment should be deleted as it suggests changes to template code that would add complexity without improving clarity, especially given the complete working example that follows.
2. docs/cookbooks/custom-tools.md:51
- Draft comment:
The 'context' variable is referenced without prior definition. Consider clarifying its origin or passing it as an argument. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% The template is meant to be a starting point that developers will modify. The actual implementation shows the correct way to use context by getting it from self.context. The template's undefined context is technically incorrect, but it's just example code that developers will need to modify anyway. The proper usage is demonstrated in the real implementation below. The comment is technically correct - the context variable is undefined in that code block. And unclear code in documentation can confuse readers. However, this is template code that's meant to be modified, and the proper implementation is clearly shown in the working example below. The template's imperfection doesn't warrant a comment since it's not production code. The comment should be removed since it's critiquing example template code that developers will modify anyway, and the correct implementation is demonstrated in the actual example below.
3. docs/cookbooks/graphs.md:20
- Draft comment:
Typo in description: 'ingest it our R2R server' should be 'ingest it into our R2R server'. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%This comment is purely informative and suggests a correction in the description, which is not allowed according to the rules. It doesn't provide a code suggestion or ask for a specific test to be written.
4. docs/cookbooks/web-dev.md:95
- Draft comment:
There is an extraneous closing bracket '];' after the file object declaration. Remove the bracket to avoid syntax issues. - Reason this comment was not posted:
Marked as duplicate.
5. docs/documentation/retrieval/advanced-rag.md:147
- Draft comment:
Possible typo: 'DeepSeeks paper' might be intended as 'DeepSeek's paper'. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% Since this is a code example, the exact text of the query string doesn't matter - it's just demonstrating the API usage. The grammatical correctness of example queries is not important for understanding how to use the API. Additionally, in other examples in the same file (line 76 and 163), the correct form "DeepSeek paper" is used, suggesting this is just an example query. The inconsistency between example queries could be confusing to readers. Having correct grammar even in examples can make documentation more professional. While professional documentation is important, this is just an example query string meant to demonstrate API usage. The grammatical error doesn't impact the technical understanding. Delete the comment as it's focused on grammar in an example query string rather than any technical or functional issue.
6. docs/cookbooks/application.md:9
- Draft comment:
Typographical suggestion: The phrase "communicate with out of the box" seems awkward. Consider rephrasing it to "communicate out-of-the-box" or "communicate with it out-of-the-box" for clarity. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% While the suggested change would make the sentence slightly clearer, this is a very minor stylistic change in documentation. The original phrasing, while not perfect, is still understandable. The rules state not to make purely informative comments or comments that are obvious/unimportant. This seems to fall into that category. The current phrasing could be slightly confusing to non-native English speakers. Documentation clarity is important for user experience. While clarity is important, this is such a minor stylistic issue that it doesn't warrant a formal PR comment. The meaning is still clear enough. Delete this comment as it's too minor of a stylistic suggestion and doesn't highlight any real issues that need fixing.
7. docs/cookbooks/application.md:39
- Draft comment:
Minor wording note: "If you're running R2R with the Docker" might be simplified to "If you're running R2R in Docker" or "with Docker" for consistency. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% While the suggestion would improve the text, it's a very minor wording change that doesn't affect technical accuracy or understanding. The rules state not to make purely informative comments or comments about obvious/unimportant things. This seems to fall into that category - it's more of a proofreading suggestion than a substantive change request. The wording is technically incorrect English and could confuse non-native speakers. Documentation clarity is important for user experience. While documentation clarity matters, this is an extremely minor grammatical issue that doesn't significantly impact understanding. The rules explicitly say not to make unimportant comments. Delete this comment as it's too minor and purely stylistic, violating the rule about not making unimportant comments.
8. docs/cookbooks/graphs.md:18
- Draft comment:
Typo: In the phrase "extract the entities and relationships from document.", it looks like an article is missing. Consider changing it to "... from the document". - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% While this is a real grammatical error, our rules emphasize focusing on substantive code issues rather than minor text fixes. This is documentation, so clarity is important, but the meaning is still clear despite the missing article. The comment is technically correct but very minor. Documentation clarity is important for user understanding. Poor grammar could reflect badly on the project's quality. While documentation quality matters, this particular error is extremely minor and doesn't impact understanding. Our rules emphasize focusing on substantial issues. Delete this comment as it addresses an extremely minor grammatical issue that doesn't impact understanding of the documentation.
9. docs/cookbooks/graphs.md:228
- Draft comment:
Typo: "searhc" should be corrected to "search". - Reason this comment was not posted:
Marked as duplicate.
10. docs/cookbooks/logging.md:9
- Draft comment:
Typo: "persistant" should be "persistent". - Reason this comment was not posted:
Marked as duplicate.
11. docs/cookbooks/maintenance.md:15
- Draft comment:
There appears to be a punctuation issue on this line. The sentence "updates statistics for the query planner to optimize performance prevents transaction ID wraparound issues, and improves overall database performance." is a bit hard to read. Consider adding a comma after "performance" to separate the clauses, e.g.: "updates statistics for the query planner to optimize performance, prevents transaction ID wraparound issues, and improves overall database performance." - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% While the comment is technically correct about improving readability, it's a very minor grammatical issue in documentation. The meaning is still clear without the comma. PR comments should focus on substantive issues that require code changes, not minor documentation style preferences. The missing comma does make the sentence harder to parse on first reading. Documentation readability is important for user experience. While readability matters, this is too minor of an issue to warrant a PR comment. Such minor documentation style fixes can be handled in bulk during documentation reviews or directly committed. Delete the comment as it addresses a very minor grammatical issue that doesn't significantly impact understanding.
12. docs/cookbooks/orchestration.md:39
- Draft comment:
Typographical error found: 'with with' on this line. Please remove the duplicate 'with'. - Reason this comment was not posted:
Marked as duplicate.
13. docs/documentation/retrieval/advanced-rag.md:147
- Draft comment:
Typographical error: In the RAG-Fusion snippet, the prompt reads "What are the main themes in DeepSeeks paper?". For consistency with the rest of the document, please change "DeepSeeks" to "DeepSeek". - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% While this is technically a valid correction for consistency, it's in a code example and is a very minor typo. The code would still work either way. According to our rules, we should not make purely informative comments or comments about obvious/unimportant issues. This seems to fall into that category. The typo could potentially confuse readers since it's inconsistent with other examples. It's in a code sample that users might copy-paste. While consistency is good, this is an extremely minor issue that doesn't affect functionality. The meaning is still clear even with the typo. Delete the comment as it points out a trivial typo that doesn't impact code functionality or understanding.
Workflow ID: wflow_keuxqINgPMY9bPIh
You can customize 
| <Frame | ||
| caption="Performing a multi-hop query over the graph" | ||
| > | ||
| <img src="../images/cookbooks/graphs/graph_search.png" alt="Performing a searhc over the graph." /> |
There was a problem hiding this comment.
Spelling error in alt text: 'searhc' should be 'search'.
Suggested change
| <img src="../images/cookbooks/graphs/graph_search.png" alt="Performing a searhc over the graph." /> | |
| <img src="../images/cookbooks/graphs/graph_search.png" alt="Performing a search over the graph." /> |
| --- | ||
|
|
||
| ## Overview | ||
| Users deploying R2R into production settings benefit from robust, persistant logging. R2R supports this via [Victorialogs](https://docs.victoriametrics.com/victorialogs), open source user-friendly database for logs from [VictoriaMetrics](https://docs.victoriametrics.com). |
There was a problem hiding this comment.
Typo: 'persistant' should be 'persistent'.
Suggested change
| Users deploying R2R into production settings benefit from robust, persistant logging. R2R supports this via [Victorialogs](https://docs.victoriametrics.com/victorialogs), open source user-friendly database for logs from [VictoriaMetrics](https://docs.victoriametrics.com). | |
| Users deploying R2R into production settings benefit from robust, persistent logging. R2R supports this via [Victorialogs](https://docs.victoriametrics.com/victorialogs), open source user-friendly database for logs from [VictoriaMetrics](https://docs.victoriametrics.com). |
|
|
||
| ## PostgreSQL VACUUM | ||
| PostgreSQL's VACUUM operation is a critical maintenance process that reclaims storage space occupied by deleted or obsolete data, | ||
| updates statistics for the query planner to optimize performance prevents transaction ID wraparound issues, and improves overall |
There was a problem hiding this comment.
The sentence is hard to read; consider adding commas or rephrasing to clarify that it updates statistics, prevents transaction ID wraparound, and improves overall performance.
Suggested change
| updates statistics for the query planner to optimize performance prevents transaction ID wraparound issues, and improves overall | |
| updates statistics for the query planner to optimize performance, prevents transaction ID wraparound issues, and improves overall |
|
|
||
| ## Orchestration GUI | ||
|
|
||
| By default, the R2R Docker ships with with Hatchet's front-end application on port 7274. This can be accessed by navigating to `http://localhost:7274`. |
There was a problem hiding this comment.
Minor typo: 'ships with with' contains a duplicate 'with'.
Suggested change
| By default, the R2R Docker ships with with Hatchet's front-end application on port 7274. This can be accessed by navigating to `http://localhost:7274`. | |
| By default, the R2R Docker ships with Hatchet's front-end application on port 7274. This can be accessed by navigating to `http://localhost:7274`. |
| ### Ingestion and Extraction | ||
| Before we can extract entities and relationships from a document, we must ingest a file. After we've successfully ingested a file, we can `extract` the entities and relationships from document. | ||
|
|
||
| In the following script, we fetch *The Gift of the Magi* by O. Henry and ingest it our R2R server. We then begin the extraction process, which may take a few minutes to run. |
There was a problem hiding this comment.
Typo: The sentence ingest it our R2R server. appears to be missing a preposition. Consider revising it to ingest it into our R2R server.
Suggested change
| In the following script, we fetch *The Gift of the Magi* by O. Henry and ingest it our R2R server. We then begin the extraction process, which may take a few minutes to run. | |
| In the following script, we fetch *The Gift of the Magi* by O. Henry and ingest it into our R2R server. We then begin the extraction process, which may take a few minutes to run. |
|
|
||
| We can go one step further and create communities over the entities and relationships in the graph. By clustering over the closely related extractions, we can | ||
| further develop the understanding of how these entities and relationships interact. This can be particularly helpful in sets of documents where we see overarching | ||
| or recuring themes. |
There was a problem hiding this comment.
Typo: 'recuring' should be 'recurring' in the sentence describing themes.
Suggested change
| or recuring themes. | |
| or recurring themes. |
docs/cookbooks/web-dev.md
Outdated
| ## Hello R2R—JavaScript | ||
|
|
||
| R2R gives developers configurable vector search and RAG right out of the box, as well as direct method calls instead of the client-server architecture seen throughout the docs: | ||
| ```python r2r-js/examples/hello_r2r.js |
There was a problem hiding this comment.
The code block starting here is labeled as python but the code is clearly JavaScript. Consider using javascript as the language identifier for proper syntax highlighting.
Suggested change
| ```python r2r-js/examples/hello_r2r.js | |
| ```javascript r2r-js/examples/hello_r2r.js |
| Specify the files that we'll ingest: | ||
|
|
||
| ```javascript | ||
| const file = { path: "examples/data/raskolnikov.txt", name: "raskolnikov.txt" } |
There was a problem hiding this comment.
It appears that the declaration of the file constant is intended to define an array of file objects, but the opening square bracket is missing and there's an extraneous closing ] on the following line. You might want to change it to:
const file = [{ path: "examples/data/raskolnikov.txt", name: "raskolnikov.txt" }];
| const file = { path: "examples/data/raskolnikov.txt", name: "raskolnikov.txt" } | ||
| ]; | ||
| console.log("Ingesting file..."); | ||
| const ingestResult = await client.documents.create( |
There was a problem hiding this comment.
The call to client.documents.create seems to be missing proper wrapping of its argument as an object. The function call currently is:
client.documents.create(
file: { ... },
metadata: { ... },
)
It should likely be:
client.documents.create({
file: { ... },
metadata: { ... }
});
Please adjust the syntax accordingly.
| ### JavaScript | ||
| ```javascript | ||
| client.documents.createSample({ ingestionMode: "hi-res" }) | ||
| // to ingest your own document, client.documents.create({filePath: </path/to/file>}) |
There was a problem hiding this comment.
Typo: In the JavaScript snippet for ingesting files, the file path parameter is written as client.documents.create({filePath: </path/to/file>}). The file path should be enclosed in quotes, for example: client.documents.create({filePath: "<path/to/file>"}).
Suggested change
| // to ingest your own document, client.documents.create({filePath: </path/to/file>}) | |
| // to ingest your own document, client.documents.create({filePath: "/path/to/file"}) |
There was a problem hiding this comment.
Important
Looks good to me! 👍
Reviewed fc21da8 in 3 minutes and 1 seconds. Click for details.
- Reviewed
178lines of code in12files - Skipped
0files when reviewing. - Skipped posting
12draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. docs/README.md:26
- Draft comment:
Removed Quick Links section; confirm these links aren’t needed or are relocated. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
2. docs/cookbooks/application.md:1
- Draft comment:
Removed front matter metadata; ensure essential metadata is documented elsewhere. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
3. docs/cookbooks/email.md:21
- Draft comment:
Replaced HTML image tag with Markdown syntax; verify the relative path './images/email/mailersend.png' is correct. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%The comment is asking the PR author to verify the correctness of a relative path, which falls under asking the author to double-check something. This violates the rules.
4. docs/cookbooks/evals.md:1
- Draft comment:
Removed redundant '## Overview' header to streamline the guide. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
5. docs/cookbooks/graphs.md:1
- Draft comment:
Removed the '## Overview' header to keep the documentation concise. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
6. docs/cookbooks/ingestion.md:1
- Draft comment:
Removed front matter and the '## Introduction' header; ensure content clarity remains. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
7. docs/cookbooks/local.md:1
- Draft comment:
Removed outdated front matter and warning block regarding Local LLMs; verify key deployment info is retained. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
8. docs/cookbooks/logging.md:1
- Draft comment:
Removed front matter header and '## Overview' content for clearer logging docs. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
9. docs/cookbooks/maintenance.md:1
- Draft comment:
Removed the warning block about user management restrictions; ensure maintenance guidelines remain comprehensive. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
10. docs/cookbooks/mcp.md:1
- Draft comment:
Removed the redundant '## Overview' header for brevity. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
11. docs/cookbooks/orchestration.md:1
- Draft comment:
Removed an obsolete warning block regarding user management; content is now streamlined. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
12. docs/cookbooks/structured-output.md:1
- Draft comment:
Removed the extraneous '## Overview' header to let the content lead. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
Workflow ID: wflow_wYRQD6gNzbu8M8V4
You can customize
There was a problem hiding this comment.
Important
Looks good to me! 👍
Reviewed 4441c84 in 2 minutes and 9 seconds. Click for details.
- Reviewed
98lines of code in2files - Skipped
0files when reviewing. - Skipped posting
5draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. docs/cookbooks/application.md:65
- Draft comment:
Updated image paths now use a relative './images/application/' prefix. Confirm that the new folder structure exists and is consistent across docs. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%The comment is asking the PR author to confirm the existence and consistency of a new folder structure. This falls under asking the author to double-check things, which is against the rules.
2. docs/cookbooks/application.md:88
- Draft comment:
The 'Logs' section was removed from the docs. Verify that its removal is intentional and that any references (e.g., in navigation) are updated accordingly. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%The comment asks the PR author to verify the intention behind the removal of the 'Logs' section and to ensure that references are updated. This violates the rule against asking the author to confirm their intention or to ensure things are updated.
3. docs/cookbooks/application.md:96
- Draft comment:
Both settings images use the same alt text ('Settings Page'). Consider using distinct descriptions for better accessibility. - Reason this comment was not posted:
Confidence changes required:50%<= threshold50%None
4. docs/cookbooks/email.md:10
- Draft comment:
Replaced the structure with static Markdown headings. Ensure the new layout meets design expectations. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%This comment is asking the PR author to ensure that the new layout meets design expectations, which is against the rules. It doesn't provide a specific suggestion or point out a specific issue with the code.
5. docs/cookbooks/email.md:31
- Draft comment:
Removed custom wrappers in favor of standard Markdown code blocks. Confirm that code block styling and behavior remain consistent. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%The comment is asking the PR author to confirm that the styling and behavior remain consistent after a change. This falls under asking the author to ensure behavior is intended, which is against the rules.
Workflow ID: wflow_LgzS344yzDGvFrXs
You can customize
There was a problem hiding this comment.
Caution
Changes requested ❌
Reviewed 33147a3 in 2 minutes and 32 seconds. Click for details.
- Reviewed
902lines of code in7files - Skipped
0files when reviewing. - Skipped posting
14draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. docs/cookbooks/custom-tools.md:7
- Draft comment:
Removed / wrappers around code blocks. Confirm that the interactive tab feature is no longer needed and that the formatting still meets the documentation goals. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%The comment is asking the PR author to confirm their intention regarding the removal of certain code wrappers. This violates the rule against asking for confirmation of intention or ensuring behavior is intended. Therefore, this comment should be removed.
2. docs/cookbooks/graphs.md:56
- Draft comment:
The tabbed interface for image frames has been replaced with direct components. Verify that the new layout renders correctly on GitHub Pages. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%This comment is asking the PR author to verify that the new layout renders correctly, which is against the rules. It doesn't provide a specific suggestion or point out a specific issue with the code.
3. docs/cookbooks/local.md:20
- Draft comment:
Tabbed blocks for command examples have been removed in favor of direct code blocks. Ensure consistent language identifiers (e.g. using 'zsh' in lowercase) for syntax highlighting. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% While the comment is technically correct about what changed, it's primarily about documentation formatting and doesn't suggest any meaningful code changes. The inconsistency between 'Zsh' and 'zsh' is a very minor styling issue. The comment is more informative than actionable. According to the rules, we should not make purely informative comments or comments about obvious/unimportant changes. The inconsistent capitalization of 'Zsh'/'zsh' could potentially cause syntax highlighting issues in some documentation systems. Maybe this is more important than I initially thought? Even if there were syntax highlighting issues, they would be immediately visible in the preview/build. This is the kind of thing that would be caught naturally during documentation review. The comment should be deleted as it is primarily informative rather than suggesting necessary changes, and any actual issues would be obvious during documentation review.
4. docs/documentation/retrieval/agentic-rag.md:79
- Draft comment:
Removed tab wrappers from multi-language examples. Confirm that separating Python, JavaScript, and Curl examples without tabs maintains clarity for readers. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%The comment is asking the author to confirm if the change maintains clarity, which is against the rules. It doesn't provide a specific suggestion or point out a clear issue.
5. docs/documentation/retrieval/hybrid-search.md:15
- Draft comment:
The LaTeX math block using '$$' is preserved. Verify that the target GitHub Pages environment supports rendering LaTeX equations correctly. - Reason this comment was not posted:
Comment was not on a location in the diff, so it can't be submitted as a review comment.
6. docs/documentation/retrieval/search-and-rag.md:33
- Draft comment:
Code examples and configuration sections have been updated to use plain code blocks. Review for consistency in formatting and language identifiers across Python, JavaScript, and Bash examples. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%This comment is purely informative and does not provide any actionable feedback or suggestions for improvement. It does not align with the rules for useful comments.
7. docs/cookbooks/graphs.md:16
- Draft comment:
Typo in the sentence: "...extract the entities and relationships from document." Consider inserting an article, e.g. "from the document" or "from a document", for clarity. - Reason this comment was not posted:
Comment was on unchanged code.
8. docs/cookbooks/graphs.md:18
- Draft comment:
Typographical error: "ingest it our R2R server" is missing a preposition. Change to "ingest it into our R2R server". - Reason this comment was not posted:
Comment was on unchanged code.
9. docs/cookbooks/graphs.md:137
- Draft comment:
Typo: Consider using "categories" instead of "category" in the caption text for clarity (Line 137). - Reason this comment was not posted:
Comment was on unchanged code.
10. docs/cookbooks/local.md:134
- Draft comment:
Typo found: 'serach' in alt text should be corrected to 'search'. - Reason this comment was not posted:
Comment was on unchanged code.
11. docs/cookbooks/local.md:155
- Draft comment:
Typo: 'serach' should be 'search' in the alt text ('A semantic serach done with LLMs.') - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 20% vs. threshold = 50% While this is technically a valid correction, it's a very minor typo in alt text that doesn't affect functionality or understanding. Alt text is primarily for accessibility and screen readers would likely still pronounce "serach" correctly. The same typo appears in multiple places but this comment only fixes one instance. The typo does affect accessibility to some degree, and fixing it would be good practice. Also, since it appears multiple times, fixing one instance could help identify the pattern. While accessibility is important, this is an extremely minor issue that doesn't significantly impact usability. The comment also doesn't address all instances of the typo, making it incomplete. This comment should be deleted as it addresses a very minor typo that doesn't meaningfully impact functionality or understanding, and it doesn't comprehensively address all instances of the issue.
12. docs/cookbooks/local.md:161
- Draft comment:
Typo: 'serach' should be 'search' in the alt text ('A semantic serach done with LLMs.') - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% While this is technically a valid typo fix, it's a very minor issue in alt text that doesn't affect functionality. The same typo appears in multiple places (lines 134, 155, 161, 179, 200) which suggests a systematic issue. However, alt text is purely for accessibility and doesn't affect the logic or behavior of the code. The typo does affect accessibility for screen readers, which could be considered important. Also, fixing just one instance while leaving others might create inconsistency. While accessibility is important, this is a very minor typo that doesn't significantly impact comprehension. The comment also only addresses one instance of the typo rather than the systematic issue. Delete the comment as it addresses a very minor UI/accessibility issue and doesn't handle all instances of the problem.
13. docs/cookbooks/local.md:200
- Draft comment:
Typographical error: In the alt attribute, "serach" should be corrected to "search". - Reason this comment was not posted:
Comment was on unchanged code.
14. docs/documentation/retrieval/hybrid-search.md:37
- Draft comment:
Typo: It looks like "RRF" should be "R2R" to maintain consistency with the project's name. - Reason this comment was not posted:
Comment was on unchanged code.
Workflow ID: wflow_sD0jL61mj78TcpFD
You can customize
|
|
||
| R2R gives developers configurable vector search and RAG right out of the box, as well as direct method calls instead of the client-server architecture seen throughout the docs: | ||
|
|
||
| ```python |
There was a problem hiding this comment.
The code block is labeled as 'python' though it contains JavaScript code. Change the language identifier to 'javascript' to enable proper syntax highlighting.
Suggested change
| ```python | |
| ```javascript |
| <Frame | ||
| caption="Pulling extractions into the graph" | ||
| > | ||
| <img src="../images/cookbooks/local/pulling_extractions.png" alt="A semantic serach done with LLMs." /> |
There was a problem hiding this comment.
Typo: 'serach' should be 'search' in the alt text ('A semantic serach done with LLMs.')
Suggested change
| <img src="../images/cookbooks/local/pulling_extractions.png" alt="A semantic serach done with LLMs." /> | |
| <img src="../images/cookbooks/local/pulling_extractions.png" alt="A semantic search done with LLMs." /> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Important
Migrates R2R documentation from Fern to GitHub, including setup guides, cookbooks, and advanced feature documentation.
This description was created by
for 33147a3. You can customize this summary. It will automatically update as commits are pushed.