Documentation Improvements Fairytale#34
Open
aravipati1 wants to merge 1 commit intoschnaader:masterfrom
Open
Conversation
Improved the documentation.
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.
Detailed Description(what should change, what did change):
With Fairytale, I made significant improvements to the documentation to make it more informative and straightforward for users to follow and build on. The documentation lacked proper detailed instructions on how to use it and its features so I made sure to list out all its features and made it clear to users how to build it in Windows and Linux. Additionally, I added three new sections to the documentation. The documentation lacked user quality of life features that would help readability and applicability significantly. Firstly, I added a usage section that gave users tips on how to compress, decompress, and configure compression options with Fairytale. Next, I added performance tips to advise users for a smoother experience. It is important that users are aware of certain issues and limitations that might impede on their experience. Therefore, the final section I added listed the known issues and limitations to make sure users look out for those errors.