Add README.md and CHANGELOG.md to the docs #168
Merged
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
README.md is now the entry point of the docs instead of "API Reference".
|
💚 💙 💜 💛 ❤️ |
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.
I've been upgrading my app, and as part of the upgrade I bumped
phoenix_live_reloadto the latest version (v1.5.3). In the change log I found a mention of:web_console_logger.The docs for
:web_console_loggerrefer toREADME.mdfor instructions on how to setup streaming server logs to the web console, butREADME.mdis not included in the docs, so I had to leave Hexdocs and go to Github to read the instructions.In this PR I've added
README.mdandCHANGELOG.mdto the docs, I've also madeREADME.mdthe entry point of the docs (instead of the "API Reference" page).