Create a proper docs website #56

Closed
fgrehm opened this Issue Nov 6, 2013 · 4 comments

Comments

Projects
None yet
3 participants
@fgrehm
Owner

fgrehm commented Nov 6, 2013

We actually started discussing this a while ago but we didn't talk much about it. Since then our README has grown too big and is about time for us to clean things up :)

I'm up for using some static site generator to do this like jekyll or middleman but I suck at UIs and I'd love to use some nice looking pre-made template.

What do you guys think?

@fgrehm fgrehm referenced this issue Nov 6, 2013

Merged

Release 0.5.0 #55

@gimler

This comment has been minimized.

Show comment
Hide comment
@gimler

gimler Nov 7, 2013

Contributor

alternative we can create a doc folder with the markdown files and use the github rendering. it is simplier also to update the content same repro but it is not really powerfull.

Contributor

gimler commented Nov 7, 2013

alternative we can create a doc folder with the markdown files and use the github rendering. it is simplier also to update the content same repro but it is not really powerfull.

@fgrehm

This comment has been minimized.

Show comment
Hide comment
@fgrehm

fgrehm Nov 7, 2013

Owner

I think it is a great start actually, I was thinking about a fully blown website but we can start by moving things out of the readme and continue from there :)

Owner

fgrehm commented Nov 7, 2013

I think it is a great start actually, I was thinking about a fully blown website but we can start by moving things out of the readme and continue from there :)

@patcon

This comment has been minimized.

Show comment
Hide comment
@patcon

patcon Nov 7, 2013

Collaborator

@gimler++ big fan of keeping docs in the same repo and branch. Github's encouragement of this gh-page practice is really unfortunately in my opinion, because you can't enforce updated documentation as part of any pull request :)

Collaborator

patcon commented Nov 7, 2013

@gimler++ big fan of keeping docs in the same repo and branch. Github's encouragement of this gh-page practice is really unfortunately in my opinion, because you can't enforce updated documentation as part of any pull request :)

@fgrehm

This comment has been minimized.

Show comment
Hide comment
@fgrehm

fgrehm Nov 11, 2013

Owner

Ok folks, I've found out about @progrium's brand new viewdocs project and I think we could use it here :)

What do you guys think?

Owner

fgrehm commented Nov 11, 2013

Ok folks, I've found out about @progrium's brand new viewdocs project and I think we could use it here :)

What do you guys think?

@fgrehm fgrehm closed this in #64 Dec 12, 2013

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment