Hey #developers folks — I've got a request for y'all! As we are constantly trying to improve our developer experience here @algolia, we want to empower you with the best docs possible. 👉 Would you share your favorite #documentation, and the WHY behind? 📄💻
@NicolasMzrd @algolia I really enjoy the dev portal by @heroku - easy to navigate and they’ve got guides/tutorials/api reference well balanced. My personal goal by end of the year is to get the @moltin docs to follow a similar approach 💪
@NicolasMzrd @manekinekko @algolia The @angular team rebuilt their entire docs site. And the result is fantastic. Nicely structured, tons of examples, links to live examples at @stackblitz, works offline (#pwa) and all api docs are linked to implementation on github
@NicolasMzrd @algolia @Cypress_io has some of the best documentation. Not only do they explain the how, with multiple examples, but also go in to best practices and they use algolia search. Also error messages w/how to fix! @djangoproject also has excellent documentation with lots of examples.
@NicolasMzrd @algolia @vuejs : the right answer at each step of learning @Cypress_io : full of examples
@NicolasMzrd @algolia I really love @vuejs' docs: great content and examples for newcomers but still super useful as a reference whenever you don't remember lifecycle hooks or you want to dig deeper inside certain topics like SSR / pre-rendering. Highly recommended 💯
@NicolasMzrd @algolia Your docs and support of it are really good, and makes the rest of us look bad 😩
@NicolasMzrd @algolia 1) @laravelphp for exhaustivity and easyness of reading 2) @stripe for lettering 3) Any docs that is using @algolia DocSearch
@NicolasMzrd @algolia I was actually just reading the Algolia Search intro docs and they struck me as *very* fun to read and still precise. Then again, maybe your docs will be wrong one day and I will @ u. :)
@NicolasMzrd @algolia doc.rust-lang.org/book/ is amazing in terms of writing. I like it mainly because technical decisions are also explained whilst reading the doc, so by the end you not only understand how it works, but you also know why it works like that.
@NicolasMzrd @algolia Do you know you can nominate your favorite docs portals to @DevportalAwards in 9 different categories? Submissions are accepted until September 15th here: devportalawards.org
@NicolasMzrd @algolia Wow @vuejs getting a lot of #documentation ❤️
@NicolasMzrd @algolia Big fan of the @GatsbyJS one, because it's very detailed and clear
@NicolasMzrd @algolia @djangoproject for the design, the writing and the exhaustivity. But really need a Docsearch!
@NicolasMzrd @TheLarkInn @algolia I’d say @stripe for the clarity of both the informations and the design. Everything just works well when I follow their docs.
@NicolasMzrd @algolia 1) Laravel , coz well documented and i like the theme color they maintained. 2) VueJs seems like laravel, but loaded very fast. Both are mobile friendly!
@NicolasMzrd @TheLarkInn @algolia Although I am a react.js man but I like vue.js document bcos it was fully documented
@NicolasMzrd @algolia @vuejs documentation is primo because it's a beautiful balance of implementation examples and explanatory information. @zeithq 's Next has solid documentation, but I did wish it wasn't in 3 places. I really appreciate the examples folder on their GitHub.
@NicolasMzrd @TheLarkInn @algolia A nice thing about @vuejs guide is that you get an overview in "Introduction", then goes deeper in the rest of "Essentials" and even deeper in the rest of the docs. "Essentials" itself is enough for understanding most of the full examples in internet.
@NicolasMzrd @algolia for REST API docs I like @apiaryio
@NicolasMzrd @algolia developers.braintreepayments.com - I love the writing, the eye-catching graphics, and the easy-to-follow UI (navigation and page-design)
@NicolasMzrd @algolia +1 for @vuejs, incredibly easy to find relevant content with lots of useful code examples with concise explanations. Also shoutout to @jquery for having clear writing and great examples - not a sexy site, but it never let me down when I was learning JS.
@NicolasMzrd @developerjack @algolia I like the Mozilla Teaching Pages, they're really well done. Oh and JWplayer. That's a great set too.
@NicolasMzrd @algolia Personally a fan of the way React-Router has done it. reacttraining.com/react-router/w…
@NicolasMzrd @algolia The reference with good navigation is the best.