Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add porcelain docs that are organized according to the git man page #697

Open
sheluchin opened this issue Apr 3, 2019 · 1 comment
Open

Add porcelain docs that are organized according to the git man page #697

sheluchin opened this issue Apr 3, 2019 · 1 comment

Comments

@sheluchin
Copy link

@sheluchin sheluchin commented Apr 3, 2019

In looking at various git-related tooling, I came across this docs page from pygit2.

A list of some standard git commands and their pygit2 equivalents. This document is a work in progress, and is organized according to the git man page.

The idea there is to create a list of common recipes and organize them similarly to the git man page. I think this would be a helpful approach, as people looking at Dulwich are likely already somewhat familiar with the git docs. It could help with onboarding and reducing "how to do x using Dulwich" support tickets.

Anyway, thanks very much for all your work in building and maintaining this project. This is by no means a complaint, just an idea.

@jelmer
Copy link
Member

@jelmer jelmer commented Apr 3, 2019

That would make sense for the porcelain module, at least; contributions in this area would certainly be welcome!

@jelmer jelmer changed the title Suggestion: organize docs according to the git man page Add porcelain docs that are organized according to the git man page Apr 3, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.