docs: Add context poisoning section to advanced usage documentation#172
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Contributor
There was a problem hiding this comment.
Important
Looks good to me! 👍
Reviewed everything up to 1197776 in 1 minute and 5 seconds. Click for details.
- Reviewed
74lines of code in2files - Skipped
0files when reviewing. - Skipped posting
6draft 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/advanced-usage/context-poisoning.md:38
- Draft comment:
Minor: remove the extra space before the period in this bullet for consistency. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%This comment is purely about formatting and does not provide any substantial feedback on the code itself. It is not related to any of the rules or guidelines provided, and it does not suggest any code improvements or highlight any potential issues.
2. sidebars.ts:97
- Draft comment:
Ensure that the new 'advanced-usage/context-poisoning' entry is placed in the desired order. - Reason this comment was not posted:
Confidence changes required:33%<= threshold50%None
3. docs/advanced-usage/context-poisoning.md:38
- Draft comment:
There is an extra trailing space before the period at the end of the sentence. Please remove the extra whitespace for consistency. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =20%<= threshold50%The comment is about a minor formatting issue, which is not a significant concern in the context of code review. It doesn't provide a meaningful suggestion or address a potential issue in the code logic.
4. sidebars.ts:97
- Draft comment:
The sidebar update correctly adds the new 'context-poisoning' doc under Advanced Usage. Nice work! - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
5. docs/advanced-usage/context-poisoning.md:3
- Draft comment:
Typo: The info block declaration has four colons ('::::info') instead of the expected three (':::info'). Please fix the extra colon. - Reason this comment was not posted:
Comment looked like it was already resolved.
6. docs/advanced-usage/context-poisoning.md:38
- Draft comment:
Typo: There is an extra space before the period at the end of the sentence. Please remove the unnecessary space. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%This comment is about a minor formatting issue, which is not a significant concern in the context of code review. It doesn't relate to any of the specific rules or guidelines provided, such as code structure, error handling, or testing. Therefore, it seems to be a purely informative comment about formatting.
Workflow ID: wflow_6GpKBQPHdIETXRTL
You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Adds documentation on context poisoning and updates the sidebar to include it.
context-poisoning.mdtodocs/advanced-usage/, detailing context poisoning symptoms, causes, and recovery strategies.sidebars.tsto includeadvanced-usage/context-poisoningin the Advanced Usage category.This description was created by
for 1197776. You can customize this summary. It will automatically update as commits are pushed.