search

Riverscapes / riverscapes-jekyll-theme

Gem-based GHPages theme that all docs will consume from
https://riverscapes.github.io/riverscapes-jekyll-theme/
MIT License
0 stars 2 forks source link

Why is there a docs folder? #10

Closed joewheaton closed 4 years ago

joewheaton commented 4 years ago

Hey @MattReimer, it seems like there is an extra copy of the entire "website" in the docs folder of this repo that should not be here: https://github.com/Riverscapes/riverscapes-jekyll-theme/tree/master/docs

To get sites to work, you copy all the contents (minus this docs folder) either into the Master (if repo is nothing but a git-hosted site) or into its own docs folder if its also a code repo. I've done this a bunch recently and end up deleting this redundant docs folder. Doesn't make sense why its here other than legacy. Any reason not to delete it from template theme?

joewheaton commented 4 years ago

@MattReimer confirmed that this is NOT a mistake. The contents of that docs folder are not extra! They are the template. We agreed it made more sense to zip up those contents that people should be using for their template and put them as a release. @joewheaton will update the documentatino on http://riverscapes.xyz too.