cookiecutter/cookiecutter-django

Document each feature of this project

Open

#567 opened on Jun 2, 2016

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Python (10,896 stars) (2,713 forks)batch import
docshelp wantedhigh priority

Description

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.

Contributor guide

Tech stack
pythondjango
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
DjangoreStructuredText
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Identify the features listed in the README of the cookiecutter django project. For each feature, create a .rst file in the docs/ directory. Document what users should know, default configuration, and relevant options. Use TODOs for incomplete sections. The README is at https://github.com/cookiecutter/cookiecutter django.