Coder Social home page Coder Social logo

Comments (6)

HashNuke avatar HashNuke commented on July 4, 2024

please dont get me wrong tho. The docs are damn detailed and that's awesome. Just that having a lot of stuff on one page made it really difficult to search/skim thru to find stuff.

from rvm.

fnichol avatar fnichol commented on July 4, 2024

Sweet, I'm going to take this as a badge of honor :) I've been thinking over the past few weeks how we can improve the navigation and how to feature the more need-to-know sections of the doc. I agree that it's getting unwieldy but I'm worried about what could be left behind once the git repo is cloned, downloaded, uploaded to a Chef server, etc. So here's what I'm thinking:

  • The README could easily have HTML a anchors to provide bookmark-ability. I've already started this in a temporary branch
  • A rake task could be added that could either:
    • Split the README into sections, update the wiki project repo and push it live (thus keeping things in sync) or
    • Create a project-style GitHub site (https://fnichol.github.com/chef-rvm) that could use some JavaScript to provide section navigation--basically turning the README into a single page static app

Thoughts?

I'll keep this open in the meantime. There might be a generic pattern here for displaying cookbook docs...

from rvm.

fnichol avatar fnichol commented on July 4, 2024

OK, I've added a gh-pages branch which uses the most excellent DocumentUp:
http://fnichol.github.com/chef-rvm/

I think this is a good start :)

from rvm.

HashNuke avatar HashNuke commented on July 4, 2024

THANKS!
The docs look beautiful and are now easy to read.

from rvm.

fnichol avatar fnichol commented on July 4, 2024

DocumentUp is a pretty cool project, huh? Thanks!

from rvm.

lock avatar lock commented on July 4, 2024

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

from rvm.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.