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

Improve doc content #58

Open
5 tasks
adamltyson opened this issue May 22, 2023 · 0 comments
Open
5 tasks

Improve doc content #58

adamltyson opened this issue May 22, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@adamltyson
Copy link
Member

Linked to #36, but more about the content itself rather than the presentation:

Going through the docs as a user, I think there's room for improvement:

  • Separate information about the cookiecutter from the commands needed to be typed
  • Clarify how users can create a GitHub repo #57
  • Include commands for both ssh & https usage (my feeling is that most non-developers use https)
  • Add some kind of branching. e.g. we have the commands for modern git and git <v2.28 next to each other, I don't think this is as clear as it can be
  • I think the push command should be git push --set-upstream origin main. The remote won't have any branches
@adamltyson adamltyson added documentation Improvements or additions to documentation enhancement New feature or request labels May 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant