3 ms·

Thanks for your feedback. If it helps to know, the Q&A format on the homepage is the result of scratching my head for a while, thinking "How would I explain thi

by mholt 12y ago

Thanks for your feedback. If it helps to know, the Q&A format on the homepage is the result of scratching my head for a while, thinking "How would I explain this to somebody? There's a lot to it, and it's all immediately relevant." I eventually convinced myself that the last part isn't true. It could be disclosed in parts. So I decided to run the scenario in my mind instead: "I'll give somebody this library and imagine that they'll reveal their use cases one piece at a time and I'll help them through it." Then the conversation flowed naturally and came out while typing.

ohitsdom 12y ago
Loved the format!
findjashua 12y ago
love the conversational style of the documentation!
andrey-p 12y ago
What really got me was the desperation in the "voice" of the questions, slowly being won over by a calm father figure. I've never had to parse CSV in the browser, but now I feel like I should. Powerful stuff! I'm also a big fan of libraries where the library name is also the API (ie Papa Parse -> Papa.parse()). It just fills me with glee.
cheese1756 12y ago
Will the website itself be released under an open license? I could see this website format being useful for a ton of open source projects.
- mholt 12y ago
  I'd be okay with that, I just hadn't considered it. By format do you mean design or content (or both)? And are you thinking a Creative Commons license?
  - cheese1756 12y ago
    I meant the design, since the page created such a clear template that would be fantastic for future open source projects to modify. But if you want to release the content in the open too, all the better. I just think that a lot of open source projects which struggle with onboarding would be greatly benefited by using the page as a base.