-
Notifications
You must be signed in to change notification settings - Fork 2
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 some reference docs on all the cookiecutter options #296
Comments
It doesn't create a GitHub repository! I decided against that as too many nuances. It does things like recommending the |
Woops, I got confused. Either way it would be nice to have some reference documentation (even if it's short) about each of the options in the cookiecutter template explaining what they're used for, or what they do (which would have saved my confusion 😄 ). |
I updated the title and body of the issue to reflect the comment above ☝️ |
Yeah, I like that idea |
Should the options docs just go in the body of README.md? Perhaps in a
|
As an alternative or complement to having the options documented separately in the README or similar, |
Fixes #296 and fixes #305 Adds longer human-readable prompts for all cookiecutter template options using the `prompts` field in `cookiecutter.json` (we already had a prompt for `deploy_docs_to_github_pages` option from #319). --------- Co-authored-by: David Stansby <[email protected]>
Which Section of the Documentation Needs Improving?
It's wasn't clear from just the
cookiecutter
command line whatinitialise_git_repository
does. In particular, does it initialise the repo locally or put it on GitHub? Or neither? In general it would be good to have some reference docs on what each of the cookiecutter optiolns is used for or does.What Can be Improved About This Section
I think some reference documentation on what each of the cookicutter options means/is used for would be nice.
How to Improve This Section
No response
The text was updated successfully, but these errors were encountered: