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

Should we create a set of man pages for git flow commands with brief explanations of options for new users? #2

Open
ChrisJStone opened this issue Jun 14, 2023 · 2 comments

Comments

@ChrisJStone
Copy link
Member

Write documentation for git flow that can be installed along with git flow

@paulwwisl
Copy link

@ChrisJStone
Copy link
Member Author

ChrisJStone commented Jun 20, 2023

Isn't there https://github.com/danielkummer/git-flow-cheatsheet ?

Thank you for the repo link, I do have it in the project README. Most of the cheat sheets I have found seem assume some level of proficiency with git.

When I initially created this issue I was thinking along the lines of providing a set of man pages that could be installed along with git-flow itself. That way some one new to git could look at the man page for the particular command and see the available flags and a brief description of what they do. That way a new user could get a basic idea of what some of the advanced options do and not have to look up the option in the git manual just to find out what it does.

@ChrisJStone ChrisJStone changed the title Create documentation for git flow commands Should we create a set of man pages for git flow commands with brief explanations of options for new users? Jun 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

2 participants