Opened 10 years ago

Closed 10 years ago

Last modified 8 years ago

#136 closed enhancement (fixed)

Provide a path to read documentation files in docs/ (enhancement/trivial)

Reported by: paolo Owned by: jacob
Component: Documentation Version:
Severity: normal Keywords:
Cc: Triage Stage: Design decision needed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

Yeah, it is really valuable to have a docs/ directory always rigorously up to date. The exposition is good also.
However for people that approach Django for the first time it would be a great help to know if there is a *suggested* order to read documentation files. (Yes, I'm paranoid versus quality of documentation, it is too important!)
It would be possible to specify that order in README file and add a prefix (00_, 01_, 02_ etc) in front of each file in docs/
This ticket is about a small but important!) change, anyway in my opinion it would be another great "welcome here" to newcomers :-)

Change History (1)

comment:1 Changed 10 years ago by jacob

  • Resolution set to fixed
  • Status changed from new to closed

(In [271]) Added a "suggested reading order" to the README (fixes #136 -- thanks paolo!). Also reworded some of the language in the README and added pointers to the various help resources.

Note: See TracTickets for help on using tickets.
Back to Top