Hacker News Board Hacker News, browsed like a classic message board
Live data from Hacker News

CocoaDocs - Documentation for iOS Libraries

cocoadocs.org

Post reply on HN
Print view View original

21–30 of 31 posts

Re: CocoaDocs - Documentation for iOS Libraries

#21

Post by bennyg »

orta wrote: post #3

Hey guys & gals, I created cocoadocs to try and fill a gap in the iOS ecosystem. It's a site that acts similar to rubydocs in that it gets the latest cocoapods libraries and documents them using a custom flavour of appledoc. I'm planning on adding support for Xcode and Dash over the next few weeks to make it even easier to use!

Looks great! Only one thing, how often is it updated? I pushed a new Podspec to the master repo about 5 days ago for one of my projects (http://cocoadocs.org/docsets/Colours/0.0.1/) and it should be v1.0.1. Just wondering if you are doing live grabbing of the data or have it cached somewhere?

Re: CocoaDocs - Documentation for iOS Libraries

#22

Post by MaxGabriel »

_frog wrote: post #19

Fantastic! I can see this being incredibly useful for cases where you have multiple versions of a framework used in different projects. Right now you can install documentation into Xcode if the project uses appledoc[1], but there's no way to switch between versions. On the subject of appledoc, are you using a custom template here? It seems to improve on the default one in a few places. [1]: http://gentlebytes.com/app…

If you use Cocoapods, when you install with Appledoc it names the documentation based on versions, e.g. TTTAttributedLabel 1.6.2 so you can keep multiple sets.

Of course, that gets messy real fast, so it's good that CocoaDocs is an option.

Re: CocoaDocs - Documentation for iOS Libraries

#23

Post by orta »

bennyg wrote: post #21
orta wrote: post #3

Hey guys & gals, I created cocoadocs to try and fill a gap in the iOS ecosystem. It's a site that acts similar to rubydocs in that it gets the latest cocoapods libraries and documents them using a custom flavour of appledoc. I'm planning on adding support for Xcode and Dash over the next few weeks to make it even easier to use!

Looks great! Only one thing, how often is it updated? I pushed a new Podspec to the master repo about 5 days ago for one of my projects ( http://cocoadocs.org/docsets/Colours/0.0.1/ ) and it should be v1.0.1. Just wondering if you are doing live grabbing of the data or have it cached somewhere?

Cached for the moment, I'm wrapping up the CI server which will be constantly updating podspecs from this week onwards.

Re: CocoaDocs - Documentation for iOS Libraries

#24

Post by _frog »

MaxGabriel wrote: post #22
_frog wrote: post #19

Fantastic! I can see this being incredibly useful for cases where you have multiple versions of a framework used in different projects. Right now you can install documentation into Xcode if the project uses appledoc[1], but there's no way to switch between versions. On the subject of appledoc, are you using a custom template here? It seems to improve on the default one in a few places. [1]: http://gentlebytes.com/app…

If you use Cocoapods, when you install with Appledoc it names the documentation based on versions, e.g. TTTAttributedLabel 1.6.2 so you can keep multiple sets. Of course, that gets messy real fast, so it's good that CocoaDocs is an option.

Wow I didn't know about that, that's really handy.

Re: CocoaDocs - Documentation for iOS Libraries

#25

Post by orta »

mmorey wrote: post #17
orta wrote: post #3

Hey guys & gals, I created cocoadocs to try and fill a gap in the iOS ecosystem. It's a site that acts similar to rubydocs in that it gets the latest cocoapods libraries and documents them using a custom flavour of appledoc. I'm planning on adding support for Xcode and Dash over the next few weeks to make it even easier to use!

If you provide a /search?query=%s endpoint I would build an Alfred V2 Workflow for it. Downloading the whole documents.jsonp file each time is slow.

I'd love to but ATM its a static site hosted on s3, so no API at all. Moving to something which is API / Client is within my next major move, at that point it will be super easy.

Re: CocoaDocs - Documentation for iOS Libraries

#26

Post by nmcfarl »

orta wrote: post #25
mmorey wrote: post #17

Earlier quoted context omitted.

If you provide a /search?query=%s endpoint I would build an Alfred V2 Workflow for it. Downloading the whole documents.jsonp file each time is slow.

I'd love to but ATM its a static site hosted on s3, so no API at all. Moving to something which is API / Client is within my next major move, at that point it will be super easy.

Just having a HTML doc with a meta refresh from the distribution to the latest version would make a lot of things easier.

IE have http://cocoadocs.org/docsets/NUI/ Redirects to: http://cocoadocs.org/docsets/NUI/0.2.7/

This would enable http://cocoadocs.org/docsets/%s shortcuts

Re: CocoaDocs - Documentation for iOS Libraries

#27

Post by SeoxyS »

orta wrote: post #3

Hey guys & gals, I created cocoadocs to try and fill a gap in the iOS ecosystem. It's a site that acts similar to rubydocs in that it gets the latest cocoapods libraries and documents them using a custom flavour of appledoc. I'm planning on adding support for Xcode and Dash over the next few weeks to make it even easier to use!

This is fantastic. Great work… I will be adding this to my repertoire of resources.

Re: CocoaDocs - Documentation for iOS Libraries

#28

Post by brotchie »

orta wrote: post #3

Hey guys & gals, I created cocoadocs to try and fill a gap in the iOS ecosystem. It's a site that acts similar to rubydocs in that it gets the latest cocoapods libraries and documents them using a custom flavour of appledoc. I'm planning on adding support for Xcode and Dash over the next few weeks to make it even easier to use!

Nice! I have a "pod" in the Cocoa Pods repository and the documentation has been reproduced faithfully!

I like how you pull the github README to use at the documentation landing page.

Re: CocoaDocs - Documentation for iOS Libraries

#29

Post by MaxGabriel »

nmcfarl wrote: post #26
orta wrote: post #25

Earlier quoted context omitted.

I'd love to but ATM its a static site hosted on s3, so no API at all. Moving to something which is API / Client is within my next major move, at that point it will be super easy.

Just having a HTML doc with a meta refresh from the distribution to the latest version would make a lot of things easier. IE have http://cocoadocs.org/docsets/NUI/ Redirects to: http://cocoadocs.org/docsets/NUI/0.2.7/ This would enable http://cocoadocs.org/docsets/%s shortcuts

Orta already made an issue for this in the CocoaDocs repo :)
Post reply on HN