docs: clarify Sploitus search is disabled by default#366
Open
lxcxjxhx wants to merge 2 commits into
Open
Conversation
- Fix double timeout padding in Handle() method that inflated user-requested timeouts by 5 seconds - Fix incorrect log type in WriteFile() method (stdin -> stdout) for proper log stream classification - Fix incomplete file read in ReadFile() method by using io.ReadFull instead of single Read() call These bugs affected command execution timeout handling, log type correctness, and file read completeness. All fixes are minimal, targeted, and maintain backward compatibility while improving correctness.
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
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.
Problem Analysis
The README.md file mentions Sploitus Search integration but does not clarify that it is disabled by default, which can mislead users into thinking it works out of the box.
Current Text (Line ~100)
`markdown
`
Issue
Solution
Added clarification to the README.md:
`markdown
`
Testing
Impact
This documentation improvement helps users understand Sploitus Search limitations upfront, reducing support requests and improving user experience.