1:Improved documentation and clarified setup instructions. Fixed incons…#4
Open
Ankana-Sadhukhan wants to merge 1 commit intoRocketChat:mainfrom
Open
1:Improved documentation and clarified setup instructions. Fixed incons…#4Ankana-Sadhukhan wants to merge 1 commit intoRocketChat:mainfrom
Ankana-Sadhukhan wants to merge 1 commit intoRocketChat:mainfrom
Conversation
…istencies in command formatting, added sample output, and provided customization examples for better user experience.
|
|
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.
The following changes have been made:
Clarified Setup Instructions: Revised the setup and installation steps to ensure a smooth experience for new users, including clear instructions for creating and activating the virtual environment, and installing required dependencies.
Fixed Command Formatting: Addressed inconsistencies in formatting across command examples to improve readability and consistency. All commands are now presented in a uniform, easy-to-read format.
Added Sample Output: Provided example output for the JSONL file generated by the spider. This gives users a clearer idea of what to expect when running the tool.
Customization Examples: Added examples and explanations on how to customize certain configurations, such as the output filename and endpoint for the
read_and_send.pyscript, making the tool more flexible for different use cases.These improvements aim to enhance the overall user experience and make it easier for both new users and contributors to interact with the project.