Skip to content

Improve doc content #58

Closed
Closed
@adamltyson

Description

@adamltyson

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

Metadata

Metadata

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions