Hey guys. Not sure if it's a good idea, but worked just fine for us. We've created Docslate (https://github.com/clojurewerkz/docslate), which is pretty much a basis for all the guides/websites for our projects.
I understand that long-term plan may be going anywhere far, but for starters simple Twitter bootstrap and Jekyll website should be just fine, or?.. Check it out. In the end, it's quite customizable, has good typography. The latest effort I'm aware of that's using pretty much same thing is: Clojure Documentation Guides http://clojure-doc.org/articles/language/interop.html , there's a more "customized" project, Monger: http://clojuremongodb.info But once again - it's just a matter of time, every project sooner or later gets lots of style customizations as content grows. I really suggest taking a look at either docslate itself, or creating same thing (Bootstrap + Jekyll (or any lightweight blogging engine you love) + Markdown (or any markup language you love)), that will get you started real quick (for instance, http://typhoeus.github.com was created in under 30 minutes), and will stimulate project growth, which is in the end more important than pretty looks Hope it'd be helpful Cheers! On Tuesday, November 27, 2012 10:00:50 PM UTC+1, solnic wrote: > > On Tuesday, November 27, 2012 1:50:32 PM UTC+1, Mihael Konjević wrote: > >> Hello everyone, >> >> I'd definitely like to contribute to the new DataMapper site. First I >> think we need to define how should we approach new site. I was working on >> sites for these open source projects: >> >> http://javascriptmvc.com/ > > > I like this one! Here's a list of other sites that people pointed me to > today that I find really lovely: > > http://emberjs.com/ - personal favorite > http://batmanjs.org/ > http://compass-style.org/ - despite the dark theme, it's still really > nice and easy to read/navigate > > >> So, JavaScriptMVC site is IMHO closest in the form of what we should do >> for the DataMapper site. Other two sites, have the form of >> one-long-page-documentation, and while I think a page like that would be >> useful for the DataMapper, we should probably do something more "classic" >> in terms of design and organisation. >> > > Yes I agree. We're gonna have a lot of content so a single page is not an > option. > > >> >> I think that first we should define is a site map, and how we want the >> docs and examples to look. After that we can work on mockups and finally on >> the design. >> > > Right. So here's what I've got in mind: > > 1. Home page with a "getting started" info - I like when I open some > project website and w/o any digging I can learn quickly how to get started > with it. So that'd be nice to have for DM too. > 2. Main sections in the menu would be: > 1. Documentation > 2. Tutorials (or Guides?) > 3. API Docs > 4. Community > 1. Blog with latest news > 2. Info about contributing > 3. Links to related resources (google group, irc channel etc) > > Now the trick is that we need to split Documentation in sub-sections based > on the individual projects that we're going to have in the DM2 stack. For > example "Mapper", "Session", "Engines" etc. But I guess a simple nav menu > on the left side will be enough. For API docs we can simply embed our YARD > docs from rubydoc.info. > > In community section it would be nice to have a larger "Contribute" > section. We could add some resources about development process etc. This > could potentially have a lot of content :) > > OK so these are my initial ideas. Oh and personally I prefer a light theme > for the site and code examples! > > Thanks! > > # solnic > -- You received this message because you are subscribed to the Google Groups "DataMapper" group. To view this discussion on the web visit https://groups.google.com/d/msg/datamapper/-/2cENJHOOOosJ. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/datamapper?hl=en.
