Guides about nodegit.github.com

[orderedlist]

I'm not sure AJAXing in the content is the best call. Perhaps we can have a post-commit hook that pulls the markdown files and commits to this repository? Might be best to make this a Jekyll site if something like that were to happen.

[tbranyen]

@orderedlist I've never set up a Jekyll site or a post-commit hook in GitHub, if you'd be willing to lend a hand I'll work on a rough draft markdown file for installing NodeGit. Ideally we can turn all the docs into a static Jekyll site.

[johnhaley81]

I would also want to have guides for all of the examples that we currently have.

Additionally we should also show all of the different ways you can authenticate. That seems to come up a lot.

[mcollina]

I think we should build a workshopper in nodeschool fashion :).

[maxkorp]

I'm inclined to agree regarding Jekyll. I also really dig the workshopper idea.

[orderedlist]

I kind of love this line of documentation used by libgit2sharp. Basically, list a bunch of git commands you'd typically use on the command line, then show example code to replicate that using the library. Makes it easily relatable for new developers.

[johnhaley81]

I love this

On Sun, Feb 1, 2015, 12:29 PM Steve Smith [email protected] wrote:

I kind of love this line of documentation
https://github.com/libgit2/libgit2sharp/wiki/LibGit2Sharp-Hitchhiker's-Guide-to-Git
used by libgit2sharp. Basically, list a bunch of git commands you'd
typically use on the command line, then show example code to replicate that
using the library. Makes it easily relatable for new developers.

—
Reply to this email directly or view it on GitHub
#11 (comment)
.

[johnhaley81]

You know, I'm thinking that the convenience methods should probably aim to mirror the CLI. That would make the most sense for people trying to do normal stuff with nodegit. People that need to do more complicated stuff can then dig down through the guides but really the average user is going to want some sort of 1:1 functionality of the CLI.

[maxkorp]

I'm all for adding convenience methods to mirror CLI, but I'd be wary of ignoring focusing on convenience methods for people who aren't (If thats what you're saying). Otherwise I'd fear we end up in a situation where mirroring the CLI is easy, and the code gets rapidly more complicated as the task gets slightly more complicated.

I definitely agree on the docs though, that's a great idea.

[tbranyen]

Added in new site.