Ruby on Rails | Screencasts | Download | Documentation | Weblog | Community | Source

Ticket #7869 (new enhancement)

Opened 1 year ago

Last modified 5 months ago

[PATCH][DOCS] Improved ActionPack README

Reported by: jeremymcanally Assigned to: core
Priority: normal Milestone: 2.x
Component: ActionPack Version: edge
Severity: normal Keywords: docs, documentation, actionpack
Cc:

Description

This patch greatly enhances and refines the ActionPack README; per our style guidelines for the documentation project, READMEs will contain high level overview documentation whereas class documentation will contain low level details and examples. As such, all the examples were torn out of the README and will be placed in their proper class; in their stead is narrative exposition of the concepts behind these components with pointers to other documentation.

I realize it points to a lot of mythical documentation in the ActionController:: and ActionView::Base classes; I'm working on that, so bear with me. :)

Attachments

improved_actionpack_readme.diff (23.2 kB) - added by jeremymcanally on 03/19/07 19:35:43.

Change History

03/19/07 19:35:43 changed by jeremymcanally

  • attachment improved_actionpack_readme.diff added.

12/05/07 17:40:53 changed by marcel

I don't agree with removing code examples from the README. I always scan a new library's README for code examples before I read anything.

-1

12/05/07 18:01:30 changed by jeremymcanally

Upon applying this patch and reading over it, I think I agree with you, but I also think there was a bit too much clutter before. The idea was to move code examples closer to where the real documentation lives to (a) make them more locatable and (b) centralize them for maintenance, but I think in doing that, it makes the README much less useful.

I'll try to rework it this weekend/week.