DevDocs API Documentation • Hacker News Board

Re: DevDocs API Documentation

#71

Post by cercatrova » Thu, Oct 19, 2017, 5:05 PM UTC

ssijak wrote: post #11

Something similar which I really love for terminal is tldr : https://tldr.sh/ Behaves like a substitute for man pages with most useful examples. Saved me hours of googling and searching.

Seems similar to bro pages (as a pun on man pages): http://bropages.org/

Re: DevDocs API Documentation

#72

Post by tcfunk » Thu, Oct 19, 2017, 5:09 PM UTC

mads wrote: post #68

Nice.. I didn't know about this. Some people here seem to recommend it and they have been using it a lot apparently. Where did you learn about it? Is there a community our there I am missing out on?

I learned about it from HN during the legal issues with Dash a while back.

Re: DevDocs API Documentation

#73

Post by myfonj » Thu, Oct 19, 2017, 5:12 PM UTC

speps wrote: post #34

Thibaut wrote: post #20

Earlier quoted context omitted.

And open-source :) ( https://github.com/Thibaut/devdocs ) Disclaimer: I'm the maintainer of DevDocs

Is Elm support planned?

For `is * planned` refer to https://trello.com/b/6BmTulfx/devdocs-documentation. (Elm is in "To Do".)

Re: DevDocs API Documentation

#74

Post by ihuman » Thu, Oct 19, 2017, 5:13 PM UTC

heartbreak wrote: post #63

marceldegraaf wrote: post #10

Reminds me of Dash[1] which is especially useful when configured in your editor: press a key to open documentation for the word under the cursor. 1: https://kapeli.com/dash

The Dash author engaged in unethical practices and then attacked Apple when they closed his account. http://www.loopinsight.com/2016/10/10/apple-responds-to-dash...

Dash is back on the iOS app store[1], so they probably worked out the issue

[1] https://blog.kapeli.com/dash-for-ios-back-on-the-app-store

Re: DevDocs API Documentation

#75

Post by kornish » Thu, Oct 19, 2017, 5:22 PM UTC

rgrau wrote: post #27

marceldegraaf wrote: post #10

Reminds me of Dash[1] which is especially useful when configured in your editor: press a key to open documentation for the word under the cursor. 1: https://kapeli.com/dash

If you live inside emacs, https://github.com/areina/helm-dash/ will use dash documentation and use emacs for the search and display of the docs. Also, works on GNU/Linux and Windows. Also, free software. Also, I'm the co-author.

This is awesome - thanks for sharing your work!

Re: DevDocs API Documentation

#76

Post by ravishi » Thu, Oct 19, 2017, 5:23 PM UTC

heartbreak wrote: post #63

marceldegraaf wrote: post #10

Reminds me of Dash[1] which is especially useful when configured in your editor: press a key to open documentation for the word under the cursor. 1: https://kapeli.com/dash

The Dash author engaged in unethical practices and then attacked Apple when they closed his account. http://www.loopinsight.com/2016/10/10/apple-responds-to-dash...

What? That link doesn't have any proof that "the Dash author has engaged in unethical practices". Neither any other link I could find about the whole controversy. Actually, everyone seems to be saying things are complicated, what seemed to be true actually wasn't, it's hard to take sides, etc:

https://daringfireball.net/2016/10/apple_dash_controversy

Re: DevDocs API Documentation

#77

Post by copperx » Thu, Oct 19, 2017, 5:26 PM UTC

padiyar83 wrote: post #15

marceldegraaf wrote: post #10

Reminds me of Dash[1] which is especially useful when configured in your editor: press a key to open documentation for the word under the cursor. 1: https://kapeli.com/dash

But you pay for Dash subscription, this one seems to be free.

Subscription? Dash is not subscription based.

Re: DevDocs API Documentation

#78

Post by lpghatguy » Thu, Oct 19, 2017, 5:28 PM UTC

malnourish wrote: post #53

I've used this off and on for a while, but the hardest thing for me is breaking the google habbit (or ddg as often as not in my case) and actually performing the search on that site. I can !dd with duckduckgo to get to devdocs, but I wish there was some natural language processing that knew I wanted to look up a cpp/rust what have you term and send me there. Additionally, C# doesn't seem to be included, which is a bi…

I don't think there's any reason to use this for Rust, honestly. You'll want to unify your dependencies using `cargo doc` and then just browse std documentation on https://doc.rust-lang.org/std/ (and other stuff on docs.rs)

Re: DevDocs API Documentation

#79

Post by 52-6F-62 » Thu, Oct 19, 2017, 5:30 PM UTC

This is fantastic!

Re: DevDocs API Documentation

#80

Post by ngrilly » Thu, Oct 19, 2017, 5:34 PM UTC

I very much like DevDocs. But it looks like Python and Go documentation are incomplete. In Dash, the full documentation is available: the library reference of course, but also the language reference and other things. In DevDocs, I only see the library reference. Am I missing something?