Skip to content
This repository has been archived by the owner on Apr 11, 2024. It is now read-only.

Rename docs/index.md to docs/README.md #136

Merged
merged 3 commits into from
Mar 15, 2021
Merged

Conversation

gfscott
Copy link
Contributor

@gfscott gfscott commented Mar 15, 2021

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.md files, so you'd need to click through to actually see the table of contents.

Type of change

  • Patch: Bug (non-breaking change which fixes an issue)
  • Minor: New feature (non-breaking change which adds functionality)
  • Major: Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

  • I have added a changelog entry, prefixed by the type of change noted above
  • I have added/updated tests for this change
  • I have documented new APIs/updated the documentation for modified APIs (for public APIs)

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.
@gfscott gfscott added the documentation Improvements or additions to documentation label Mar 15, 2021
@gfscott gfscott self-assigned this Mar 15, 2021
@gfscott gfscott requested a review from a team as a code owner March 15, 2021 14:32
Copy link
Contributor

@paulomarg paulomarg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have no problems with this, but we may need to change the /README.md file to point here instead of index.

Copy link
Contributor

@thecodepixi thecodepixi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

@paulomarg paulomarg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢

@gfscott gfscott merged commit bc70452 into main Mar 15, 2021
@gfscott gfscott deleted the gfscott/index-to-readme branch March 15, 2021 15:05
@paulomarg paulomarg temporarily deployed to production March 16, 2021 17:41 Inactive
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants