Issue #7601 has been updated by Thomas Bellman.
The length is not a problem in itself, imo. But the formatting is ... non-optimal. It actually becomes easier to read when I select "No style" as the page style in Firefox. Here are a couple of concrete suggestions: - Don't f*ck with the left margin! When using the page's style sheet, the text becomes flush to my browser window's left edge. Sucks for readability. - Don't f*ck with sizes and things for headings. At least for me, the heading for each type is *smaller* than the subheadings within each type, and even than the sub-sub-headings (like the name of each parameter). - Raise the "heading level" for most things; put the heading for each type inside h2 instead of h3, and the sections within each type should likewise be headed with h3, not h4. - Use definition lists (dl, dd and dt elements) for parameters, instead of a h5 heading with a paragraph after it. ---------------------------------------- Bug #7601: Long online docs pages should be broken up https://projects.puppetlabs.com/issues/7601 Author: Randall Hansen Status: Investigating Priority: Normal Assignee: Category: Target version: Keywords: puppetcamp-eu-2011 Branch: Affected URL: Our very long docs pages are difficult to use. E.g., [http://docs.puppetlabs.com/references/2.6.8/type.html](http://docs.puppetlabs.com/references/2.6.8/type.html) -- *This ticket is a request for comment, coming out of a discussion at Puppet Camp EU, 2011. No promises whatever about implementation, but there were enough people interested to open a public discussion.* -- You have received this notification because you have either subscribed to it, or are involved in it. To change your notification preferences, please click here: http://projects.puppetlabs.com/my/account -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/puppet-bugs?hl=en.
