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

Put the docs in the wiki instead of inside of the repo #2

Closed
CoolOppo opened this issue Aug 8, 2014 · 2 comments
Closed

Put the docs in the wiki instead of inside of the repo #2

CoolOppo opened this issue Aug 8, 2014 · 2 comments

Comments

@CoolOppo
Copy link

CoolOppo commented Aug 8, 2014

No description provided.

@postmodern
Copy link

Since the docs contain some images, perhaps GitHub Pages would be a better place?

@artemdinaburg
Copy link
Contributor

I am against completely moving the documentation to a wiki. The documentation is an integral part of the code, and should be cloned with the source code. Unless there is some feature of github where wiki pages will be automatically cloned with the main repository, I'd prefer to keep the main docs with the code.

This doesn't meant that I'm against any wiki -- one would be great for maintaining an FAQ, for instance. The wiki pages can then be periodically merged into the main documentation.

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

No branches or pull requests

3 participants