Skip to content

create targeted tutorials on yargs website #26

Open

Description

@bcoe

like the approach we're starting to take with http://istanbul.js.org/, I'd love to see us split our very long yargs README document into various targeted tutorials. e.g.,

What do you think? also looping in @maxrimue @Charlotteis.

Activity

  1. varjmes commented on Aug 8, 2016

    @varjmes
    Contributor

    Hey @bcoe!

    That sounds fantastic. I'm on board.
    puts hand in
    Go team!

    ✨

  2. bcoe commented on Aug 9, 2016

    @bcoe
    MemberAuthor

    @Charlotteis I was thinking as a stop gap, until we can write some content, putting a link to a Gitter chat on the website would be good, and in the yargs README.md; various folks have requested this.

  3. lrlna commented on Aug 9, 2016

    @lrlna
    Member

    hey folks!

    I've had ideas to do this forever and literally never got around to it. Ideally I would like to see it as a set of tutorials set up as levels: i.e. first you want to get your options, then you want to have options with aliases, then you want to use a command builder. Basically you level-up. I think as a first thing, I want to compile a list of exact tutorials, and then start building them one by one. Maybe even release one weekly, like a newsletter \o/ ?

    I also think they should be relevant to what people normally do, so I ran a twitter quetionnaire, so I can hopefully get some data. I know I've written a bunch of tests with marsupial examples, but I think we should have these as IRL stuff.

  4. lrlna commented on Aug 9, 2016

    @lrlna
    Member

    In fact, so I give myself some deadlines, I'll start with option parsing this week and actually get it done.

  5. varjmes commented on Aug 10, 2016

    @varjmes
    Contributor

    I was thinking as a stop gap, until we can write some content, putting a link to a Gitter chat on the website would be good, and in the yargs README.md; various folks have requested this

    I am biased toward Slack, but that sounds like a good idea as any :)

    I've had ideas to do this forever and literally never got around to it. Ideally I would like to see it as a set of tutorials set up as levels: i.e. first you want to get your options, then you want to have options with aliases, then you want to use a command builder. Basically you level-up. I think as a first thing, I want to compile a list of exact tutorials, and then start building them one by one. Maybe even release one weekly, like a newsletter \o/ ?

    I love this. Too many times do I get tutorials that are "HERE ARE ALL THE THINGS, BYE!!!!"
    I like the idea of "you have done this, now try this, yay awesome learning, next up is this!"

  6. bcoe commented on Aug 14, 2016

    @bcoe
    MemberAuthor

    @Charlotteis would you like to join the yargs maintainer slack? if so what email should I send an invite to?

  7. varjmes commented on Aug 15, 2016

    @varjmes
    Contributor
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions