Skip to content

Instantly share code, notes, and snippets.

@fanny

fanny/good-docs.MD

Last active July 22, 2020 23:00
Show Gist options
  • Save fanny/fee7e7146a2afa3c6c21e1bd381c76d8 to your computer and use it in GitHub Desktop.
Save fanny/fee7e7146a2afa3c6c21e1bd381c76d8 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. fanny revised this gist Jul 22, 2020. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion good-docs.MD
    View file
    Original file line number Diff line number Diff line change
    @@ -116,6 +116,6 @@ https://marketplace.visualstudio.com/items?itemName=sdras.night-owl

    https://javascript.info/

    ##[`aaa`](https://javascript.info/)
    ## [`aaa`](https://javascript.info/)


  2. fanny revised this gist Jul 22, 2020. No changes.
  3. fanny revised this gist Jul 22, 2020. 1 changed file with 3 additions and 0 deletions.
    3 changes: 3 additions & 0 deletions good-docs.MD
    View file
    Original file line number Diff line number Diff line change
    @@ -116,3 +116,6 @@ https://marketplace.visualstudio.com/items?itemName=sdras.night-owl

    https://javascript.info/

    ##[`aaa`](https://javascript.info/)


  4. fanny revised this gist Jul 21, 2020. 1 changed file with 2 additions and 0 deletions.
    2 changes: 2 additions & 0 deletions good-docs.MD
    View file
    Original file line number Diff line number Diff line change
    @@ -1,3 +1,5 @@
    *From https://twitter.com/dan_abramov/status/1280949739534630919*

    > The docs are pretty comprehensive and well structured with topics ranging from quick starter guide to in-depth concepts explanation (my fav section).
    https://cloud.google.com/docs

  5. fanny revised this gist Jul 21, 2020. 1 changed file with 84 additions and 4 deletions.
    88 changes: 84 additions & 4 deletions good-docs.MD
    View file
    Original file line number Diff line number Diff line change
    @@ -6,17 +6,18 @@ https://cloud.google.com/docs
    https://docs.mongodb.com

    > Nextjs learn explains basics + docs in a perfect way. Everything you need to get started for a production app
    https://nextjs.org/learn/basics/create-nextjs-app
    https://nextjs.org/learn/basics/create-nextjs-app **


    > Playground and the beginner to advanced level examples with precise explanation in code comments. Allowing to do more, fail early and learn faster.
    > It's important to get hands dirty while learning and these docs get straight to the point
    https://typescriptlang.org/docs
    https://typescriptlang.org/docs **


    > good documentation and both step by step guide and api doc
    > Simple and elegant
    https://firebase.google.com/docs
    > tons of examples
    https://firebase.google.com/docs **


    > Great guidance and it even has a little playground included
    @@ -33,4 +34,83 @@ https://discord.js.org
    https://docs.djangoproject.com/en/3.0/

    > PWA and REPL.
    http://svelte.dev
    > and because they work offline and are simple.
    http://svelte.dev

    > 1. left sidenav doesn't change scroll position when route changes
    > 2. overall pleasing, easy-on-the-eyes design
    > 3. great search functionality
    > 4. organization is top-notch and doesn't make search the docs itself a chore
    > Tailwind.css really well organised and easy to use.
    > Concise ,pretty and has a search bar that actually works. The examples and documentation itself is well thought out and contains exactly what you need.
    https://tailwindcss.com/docs/ **

    > Imagine if the npm site was this comprehensive
    https://package.elm-lang.org/

    > I like the quality and organization
    https://laravel.com/docs/7.x

    > Generally structured information with the ability to quickly navigate(sidebar as table of contents), link to headings, API references with examples--super quick to get started with examples. In other words build and learn as you go--imo
    https://coda.io/welcome

    > Lots of runnable examples (on codesandbox) and guides.
    https://typehero.org/type-route

    > Cool stuff. Really well done. Comprehensive. Touristic.
    https://www.prisma.io/docs/

    > Are the best I've ever seen. There are dozen abstractions and but still very easy to find details. Though there are 2 things. It's been a while since I've used it last time & it's applicable only for getting API details, not for learning
    https://docs.sencha.com/extjs/7.2.0/classic/Ext.grid.Panel.html

    > really easy to read and thorough!
    http://Codefresh.io/docs

    > The function explanations are succinct and easy to understand, great examples, love the simple UI.
    http://ramdajs.com/docs/

    > They're not just detailed, they also have an epub option! https://hexdocs.pm/phoenix/Phoenix.html
    > t got nearly everything at one place and can be made available offline (which is a great help at times) http://devdocs.io
    > Perfect balance of detail, recipes, and links to deeper dives.
    https://www.apollographql.com/docs/react/

    > For the awesome design, comprehensive reference coverage, and incredibly useful inline IDE/demo environment with live runnable examples
    hologram.io/docs

    > 1. Simple, to the point that you can finish it
    > 2. Interactive, in the sense that you can open console and start hacking away
    > 3. Pointers to *officially* supported addons for making a rich front-end experience
    > 4. Recipes for some common problems
    https://vuejs.org/v2/guide/


    > Tried to do my best to write a modular tutorial, where you can choose which path to follow, depending on your needs. Has its rough edges, but I'm proud of it
    mswjs.io/docs/

    >I like how each method has a link to its source (I don't like that it links to a file with 17k lines, making the navigation pretty slow)
    > Simplicity
    > Clear examples
    > Everything in one place (left navigation)
    > I can open chrome inspector console and play with examples
    https://lodash.com/docs/

    > Kubernetes and their interactive tutorials.
    https://kubernetes.io/docs/tutorials/kubernetes-basics/create-cluster/cluster-interactive/

    > simple, elegant, clear with beautiful and readable code snippets
    https://stripe.com/docs/api

    > Beautiful design
    > Code/performance comparison with alternatives
    > Visual form builder with live updating code example
    > Many other small details that are wow
    https://react-hook-form.com/

    > straightforward if you know what you're doing, and thorough if you're a new developer. Docs with UX imo. I'm trying to make my work as accessible as a result.
    https://marketplace.visualstudio.com/items?itemName=sdras.night-owl


    https://javascript.info/

  6. fanny revised this gist Jul 21, 2020. 1 changed file with 36 additions and 2 deletions.
    38 changes: 36 additions & 2 deletions good-docs.MD
    View file
    Original file line number Diff line number Diff line change
    @@ -1,2 +1,36 @@
    > The docs are pretty comprehensive and well structured with topics ranging from quick starter guide to in-depth concepts explanation (my fav section).
    https://cloud.google.com/docs
    > The docs are pretty comprehensive and well structured with topics ranging from quick starter guide to in-depth concepts explanation (my fav section).
    https://cloud.google.com/docs

    > The search feature is super fast and amazing
    > Every single API and feature of the database is well documented with examples and sometimes diagrams
    https://docs.mongodb.com

    > Nextjs learn explains basics + docs in a perfect way. Everything you need to get started for a production app
    https://nextjs.org/learn/basics/create-nextjs-app


    > Playground and the beginner to advanced level examples with precise explanation in code comments. Allowing to do more, fail early and learn faster.
    > It's important to get hands dirty while learning and these docs get straight to the point
    https://typescriptlang.org/docs


    > good documentation and both step by step guide and api doc
    > Simple and elegant
    https://firebase.google.com/docs


    > Great guidance and it even has a little playground included
    https://svelte.dev/tutorial/basics

    > The entry point document is accessible. The language used doesn’t assume that you know a lot of stuff to start learning. How subjects are separated into sections that are easy to navigate makes me
    flutter.dev/docs

    > Awesome one, very intuitive, has everything you need and nothing more.
    My lovely form of exploring the API docs is jumping over classes via links. All needed examples provided, a could develop without trial and error from first minutes.
    https://discord.js.org

    > Django docs are the best I've seen. All documentation is tutorial style, but well-structured so that one xany quickly to jump into it and find what they are looking for.
    https://docs.djangoproject.com/en/3.0/

    > PWA and REPL.
    http://svelte.dev
  7. fanny created this gist Jul 21, 2020.
    2 changes: 2 additions & 0 deletions good-docs.MD
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,2 @@
    > The docs are pretty comprehensive and well structured with topics ranging from quick starter guide to in-depth concepts explanation (my fav section).
    https://cloud.google.com/docs