Skip to content

docs: move README to root - #1630

Merged
jsjoeio merged 1 commit into
mainfrom
1240-bug-readmemd-links-404-when-you-download-repo-as-zip
May 20, 2022
Merged

jsjoeio merged 1 commit into
mainfrom
1240-bug-readmemd-links-404-when-you-download-repo-as-zip

Conversation

@jsjoeio

@jsjoeio jsjoeio commented May 20, 2022 •

Copy link
Copy Markdown
Contributor

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.

Testing

  1. Visit branch on GitHub here: https://github.com/coder/coder/tree/1240-bug-readmemd-links-404-when-you-download-repo-as-zip
  2. Click "Download as Zip"
  3. Open in editor aka VS Code
  4. Visit links in README.md

Fixes #1240

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.
@jsjoeio jsjoeio self-assigned this May 20, 2022
@jsjoeio
jsjoeio marked this pull request as ready for review May 20, 2022 16:50

@bpmct bpmct left a comment •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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

@bpmct
bpmct requested a review from khorne3 May 20, 2022 16:55
@jsjoeio
jsjoeio merged commit 0622603 into main May 20, 2022
@jsjoeio
jsjoeio deleted the 1240-bug-readmemd-links-404-when-you-download-repo-as-zip branch May 20, 2022 16:56
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bug: README.md links 404 when you download repo as .ZIP

2 participants