Skip to content
This repository has been archived by the owner on Aug 5, 2020. It is now read-only.

Question: Move documentation from separate repository to README.md #86

Open
k00ni opened this issue Mar 20, 2017 · 1 comment
Open

Question: Move documentation from separate repository to README.md #86

k00ni opened this issue Mar 20, 2017 · 1 comment
Assignees
Labels

Comments

@k00ni
Copy link
Member

k00ni commented Mar 20, 2017

Reasons against separate repo:

  • documentation became outdated, because updating documentation can be time consuming
  • different branches, different versions .. how to keep documentation aligned with latest development efforts?
  • website building using Jekyll sucks. I spend too much time formatting stuff without a result. Using plain markdown provides less options, but you at least can control the output.
@white-gecko
Copy link
Member

  • I don't get how moving the documentation into a huge README would solve this problem.

  • Markdown + header is enough for jekyll

  • + heaving a separate repository allows better organization of the documentation

  • -> the webpage could be reorganized

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

2 participants