dthree / wat

Instant, central, community-built docs
MIT License
495 stars 25 forks source link

Mention Dash #4

Closed silvenon closed 9 years ago

silvenon commented 9 years ago

It seems that Dash is trying to solve a similar problem. Maybe write a little comparison?

dthree commented 9 years ago

Fo sho. I'll put that together and throw it in the readme or FAQ.

Kapeli commented 9 years ago

I'm the developer behind Dash.

Dash is about making docs from different sources searchable and available in a single app. It mostly focuses on the official docs, but also has cheat sheets or offline stack overflow support or can generate docs for any Ruby gem and so on.

I love seeing new documentation approaches and I'm going to follow wat closely. If wat takes off, I'm probably going to ask for permission to add wat as a source of docs in Dash.

Good luck! :purple_heart:

dthree commented 9 years ago

@Kapeli you're rad and thanks for your support. Dash looks fantastic as well and I do hope we can complement each other. I'll have no problem with you using wat docs.

silvenon commented 9 years ago

:heart:

dthree commented 9 years ago

:heart_decoration:

dthree commented 9 years ago

@Kapeli I'll be putting something like this on Wat's main readme.

Feel free to edit it however you want and I'll throw it up there! :purple_heart:

How does Wat relate to Dash?

Dash is extraordinarily well put together API Documentation Browser and Code Snippet Manager for OS X and iOS. It stores snippets of code and instantly searches offline documentation sets for 150+ APIs.

Dash is a desktop application, and is more focused on centralizing official docs in addition to its cheat sheets. Wat is a command-line-based application and is more targeted at centralizing smaller libraries across all languages.

Whichever your preference, Dash and Wat intend to work together to cover all bases, with the common purpose of giving you fast-as-possible reference to the code you use.

dthree commented 9 years ago

@silvenon I wouldn't mind your input as well :)

silvenon commented 9 years ago

I don't have anything more to add. From your comparison it's clear that they do have an overlap, but that Wat is specialized for cheat sheets.

Qix- commented 9 years ago

To be clear, wat is less of a cheatsheet and more of a quick reference (and by quick, I mean useless if you don't know what the command is to begin with).

Therein lays the beauty; most people know what they're looking for, but the intricate details are drowning in auxiliary man pages and documentation. Wat just takes out the parts you (most likely) really need.

dthree commented 9 years ago

@Qix- we're going to have to come up with a definitive thing to call it, then. In my readme, I think I both call it snippits and cheat sheets, which isn't very certain. It would be better if it had an exact term, like "usage snippits" or something. Not sure.