Grails

docs: TOC for each chapter, and favicon

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Minor Minor
  • Resolution: Fixed
  • Affects Version/s: None
  • Fix Version/s: 1.2 final
  • Component/s: Documentation
  • Labels:
    None
  • Patch Submitted:
    Yes

Description

Several minor refactorings and and two "improvements" overlapped, so this became rather large.

The attach patch (and file) will:

  • Each chapter page will have a TOC of it's sections, below page heading, above chapter summary
  • Add favicon to documentation
  • Fix individual section pages that were not being correctly linked to stylesheet
  • Errors in reference docs show path to file, not just file name
  • Code refactoring in Generate.groovy to rename ambiguous vars, remove old, reuse code

I've attached a simple "grails-doc-icon.ico" file for favicon, since the grail with the blue dot background ("official" grails logo?) was hard to make out at such a small size. I think it works as a placeholder, until something more 'official' was chosen. It goes in "grails-doc/resources/img/grails-doc-icon.ico"

Activity

Hide
Chad McHenry added a comment -

Priority on this should have been Minor, not Major.

Show
Chad McHenry added a comment - Priority on this should have been Minor, not Major.
Hide
Graeme Rocher added a comment -

Assigning all documentation related issues to 1.2 final since they don't represent a change to the codebase

Show
Graeme Rocher added a comment - Assigning all documentation related issues to 1.2 final since they don't represent a change to the codebase
Hide
Graeme Rocher added a comment -
Show
Graeme Rocher added a comment - Fixed by http://github.com/grails/grails/commit/c194c8df186589181f4f94b1039e16dc1e5d3c9d Thanks for the contribution

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: