Document each feature of this project

cookiecutter / cookiecutter-django

Cookiecutter Django is a framework for jumpstarting production-ready Django projects quickly.

https://cookiecutter-django.readthedocs.io

BSD 3-Clause "New" or "Revised" License

12.16k stars 2.91k forks source link

Document each feature of this project #567

Open audreyfeldroy opened 8 years ago

audreyfeldroy commented 8 years ago

It would be nice if each feature listed in README had its own .rst file in docs/ with detailed documentation explaining:

What users should know about it
How it is configured by default in Cookiecutter Django
Which options correspond to or affect it, if any

More than one person can work on this at a time -- just comment with which part you are working on.

If you don't understand everything about a particular feature, that's OK. Just document what you can and leave TODOs where you want others to help out.

kappataumu commented 8 years ago

Sorry that I'm hijacking this issue, but as a side note, regarding documentation, it is not immediately obvious where one should look for further info regarding configuration and setup. Nothing pops out, and a Ctrl+F "Documentation" yields no results when at the project's GitHub page.

In contrast, the cookiecutter project itself does a much better job, being quite upfront with this.

If this is the official place (I know it is, also #335), maybe a a prominent link should be placed in the README, near the top.

audreyfeldroy commented 8 years ago

Thanks @kappataumu, that's a great point. Could you help us out by creating a new issue for that? I'll mark it high-priority and hopefully we'll get a fix from someone during the sprints 😄

ghost commented 8 years ago

Interested in bandwagoning onto this feature. I'm not sure if there's some part of the docs that need more urgent updating than the others though.

EDIT: Happy to add some more on the part about GulpJS/GruntJS integration, as far as other tasks besides live Sass/LESS CSS compilation goes.

kappataumu commented 8 years ago

No problem @audreyr, opened #588. Will someone handle all the doc issues together, or should I just go ahead and submit a fix?

reedjones commented 1 month ago

I can help with this