docs: move README to root #1630
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
We noticed that when you download the repo as a ZIP from GitHub, it places the `README.md` in the root, which causes the relative links to break. By moving it to the root, this will fix that issue.
bpmct
approved these changes
May 20, 2022
There was a problem hiding this comment.
This LGTM. I actually kinda like how the docs folder doesn't have a root and gets straight to the point. As the project advances more, I can see the need for a docs/README.md too versus the overview/quickstart content on ./README.md. Also tagging @khorne3 for thoughts
jsjoeio
added a commit
that referenced
this pull request
May 20, 2022
It appears we were manually moving the `README.md`. This should have been updated in #1630 but slipped through CI
jsjoeio
added a commit
that referenced
this pull request
May 20, 2022
It appears we were manually moving the `README.md`. This should have been updated in #1630 but slipped through CI
kylecarbs
pushed a commit
that referenced
this pull request
Jun 10, 2022
We noticed that when you download the repo as a ZIP from GitHub, it places the `README.md` in the root, which causes the relative links to break. By moving it to the root, this will fix that issue.
kylecarbs
pushed a commit
that referenced
this pull request
Jun 10, 2022
It appears we were manually moving the `README.md`. This should have been updated in #1630 but slipped through CI
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.
We noticed that when you download the repo as a ZIP from GitHub, it
places the
README.mdin the root, which causes the relative links tobreak.
By moving it to the root, this will fix that issue.
Testing
README.mdFixes #1240