This repository was archived by the owner on Apr 11, 2024. It is now read-only.
Merged
Conversation
Since the primary context for consuming this content is directly in GitHub, if we change this filename to README.md, it will display the page content when browsing this directory.
paulomarg
reviewed
Mar 15, 2021
thecodepixi
approved these changes
Mar 15, 2021
Contributor
thecodepixi
left a comment
thecodepixi
left a comment
There was a problem hiding this comment.
You beat me to it! I just noticed this while working on my other docs PR. Ditto Paulo's comment about changing the link in the main README though.
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
WHY are these changes introduced?
Since the primary context for consuming this content is directly browsing GitHub, if we change this filename to README.md, it will display the page content when browsing this directory. That doesn't happen for
index.mdfiles, so you'd need to click through to actually see the table of contents.Type of change
Checklist
I have added/updated tests for this changeI have documented new APIs/updated the documentation for modified APIs (for public APIs)