-
Notifications
You must be signed in to change notification settings - Fork 813
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation to project repo #1402
Merged
Merged
Conversation
This file contains 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.
With
patchthecode.com
currently down, there is limited access to the documentation. While a zip file with HTML files is possible to use, it would be better to have the documentation available in a more easily accessible format.This PR seeks to take the information provided in the zip file from #1397 (comment) and copy it into a new set of Markdown files contained within the project repo itself as a baseline step for improved documentation access.
It is important to note that the information contained within these new files may be out of date with respect to the current project, and so further improvements to the documentation will need to be made.
I have also included a few flags throughout these new files, to highlight areas of improvement, and to warn those using the documents that they may be out of date.
Additionally, this PR includes changes to the readme to remove external site references since they no longer work, as well as including new links to the documentation.
Finally, this PR includes a new CONTRIBUTING.md file, since this appeared to be a broken link. The file is essentially empty, and will need to be added to in future