Updated config.md#216
Merged
Merged
Conversation
Added more information on structure and features in the documentation. Requires further input from community.
dalyIsaac
reviewed
Jun 28, 2021
Member
There was a problem hiding this comment.
I think this is a great start! At some point I'll add some comments to the codebase itself and associated documentation.
For the markdown, I'd recommend using the vscode extensions markdownlint and Markdown All in One - I think Markdown All in One has a formatter which resolves all of markdownlint's issues.
incorporated suggestions and formatting changes Co-authored-by: Isaac Daly <isaac.daly@outlook.com>
dalyIsaac
reviewed
Jun 28, 2021
josteink
approved these changes
Jun 28, 2021
Member
|
A mighty improvement in documentation quality 🤠 |
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
3 participants
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.
Added more information in the documentation. I tried to clearly state some of the features and general structure of the project but still a lot could be done to improve this so I'm happy if people review and request changes accordingly