docs: add installation, usage and configuration guides (closes #3)#60
Open
smilesz10 wants to merge 1 commit intobos-com:mainfrom
Open
docs: add installation, usage and configuration guides (closes #3)#60smilesz10 wants to merge 1 commit intobos-com:mainfrom
smilesz10 wants to merge 1 commit intobos-com:mainfrom
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
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.
Summary
This update introduces comprehensive documentation to help users set up and interact with the project effectively. It addresses the missing guides for the initial environment setup and feature usage.
Changes
Installation Guide: Added step-by-step instructions for environment setup and dependency installation.
Usage Guide: Documented core features and basic commands for new users.
Configuration Guide: Detailed the available configuration options and environment variables.
Related Issues
Closes #3