Improve the documentation by splitting apart the readme sections into separate files #259
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
* Create documentation directory * Move configuration into docs file * Move notification options into docs file * Reorganize readme into a reusable pattern
kattrali
added a commit
that referenced
this pull request
Nov 30, 2015
Improve the documentation by splitting apart the readme sections into separate files
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 readme file has gotten fairly long and hard to follow. This pull request breaks it up into separate files, categorizing "readme stuff" as the basics which users need to get started, find support, and contribute, and moving the other stuff into the
docs/directory. Hopefully the format can then be reused by other notifier libraries for consistency.The remaining readme content is largely the same, just reorganized into the installation -> basic usage -> support flow.
New files
docs/README.md: Index of the documentation directorydocs/Configuration.md: All configuration optionsdocs/Notification Options.md: notification-specific options as well as custom handling for various frameworks and non-fatal exceptionsOther concerns
The readme is linked from the bugsnag.com documentation, are there any problems presented by splitting the file?
/cc @snmaynard