Make docs more scannable #7

Closed
mtitolo opened this Issue Mar 13, 2013 · 3 comments

3 participants

@mtitolo
CocoaPods member

I find my self using the RubyDocs more frequently than the official Docs. Mostly this is because the real docs have no type information, so even when going through an index I can't reasonably scan.

It's also difficult using these docs to see relationships between objects without having both pulled up in separate tabs. There's also no hierarchy to objects, when one definitely exists. I've seen this with both the docs for the cocoapods and xcodeproj gems.

@fabiopelosin
CocoaPods member

Indeed, a good point. I need to experiment a bit with the layout to accommodate the types in the indexes.

About the relationships are you referring to a functionality similar to the class list presented on the left frame by RubyDocs?

@mtitolo
CocoaPods member

Exactly! The left-hand pane is extremely helpful when trying to both find objects, and figure out how things are related.

@orta
CocoaPods member

Closing as this has been superseded by the guides.

@orta orta closed this Nov 27, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment