Version 3 (modified by 5 years ago) ( diff ) | ,
---|
Google's Season of Docs.
Summer of Code has been a real boon to Django. We'd like to participate too in Google's Season of Docs.
Generally Django's docs are great. So much so that folks send thanks.
Repeatedly though we've had one observation, that a specialist technical writer could really help us with. The Contributing Guide is, frankly, overwhelming.
There are something like 5 or 6 thousand words. It's got everything you need to know. But it's not approachable. Repeatedly, new contributors report that they just can't get going.
There's advice for new contributors, walkthroughs on submitting a patch, and so on. In theory everything you need to know. But it's not structured in the best way possible. It's clearly not offering the best on-ramp.
We'd love to encourage more contributors, and more contributors from across the community. A Season of Docs project focused on making Django's Contributing Guide more accessible would go a long way to promoting that goal.
Any queries are very welcome on the Forum contributing channel.