[DOCS-4780] MMS Manual page layout suggestion Created: 05/Feb/15 Updated: 11/Jan/17 Resolved: 05/Feb/15 |
|
| Status: | Closed |
| Project: | Documentation |
| Component/s: | Cloud Manager |
| Affects Version/s: | None |
| Fix Version/s: | 01112017-cleanup |
| Type: | Improvement | Priority: | Major - P3 |
| Reporter: | Michael Benoit | Assignee: | Unassigned |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Attachments: |
|
| Participants: | |
| Days since reply: | 9 years, 1 week, 6 days ago |
| Description |
|
I'm not too sure if this is the best place for this, so feel free to move it if necessary. I've noticed that the MMS Manual's page layout is not very responsively designed. Here's what I've observed: The Good
The Not-So-Good
I noticed this while looking at one of the Public API reference pages: In the Entity Fields section, there's a table that could definitely benefit from more horizontal space. So, here are my suggestions:
|
| Comments |
| Comment by Michael Benoit [ 05/Feb/15 ] |
|
Fair enough – thanks marc.gurney@10gen.com! |
| Comment by Marc Schaffner-Gurney (Inactive) [ 05/Feb/15 ] |
|
Propose to resolve as "Works as Designed" |
| Comment by Marc Schaffner-Gurney (Inactive) [ 05/Feb/15 ] |
|
We do not want the content column to be 100% width, the max-width is there to optimize for legibility. This is a basic rule of typography and it is the reason that well designed documentation sites, blogs, printed textbooks, etc. have a fixed max-column-width. "Measure (or sometimes "The Measure") in typography is the length of a line of text. For a single-column design measure should ideally lie between 40 and 80 characters. Many typographers consider the perfect measure to be 65 characters. If the lines are too short then the text becomes disjointed, if they are too long the content loses rhythm as the reader searches for the start of each line. Punctuation should preferably hang outside the measure." The max-width on the content column of MongoDB and MMS Docs currently averages around 100 characters per line. We do not want to make this column any wider. The right sidebar automatically drops off on smaller screen sizes (good) and the left sidebar auto-hides on even smaller screen sizes (good). The measure for the right table-cell ("Description" column) is in the high 70s, still at the upper range of the ideal 40-80, and it seems perfectly legible to me when reading the content as I normally would read content on a page. I do find it hard to read the lists of "possible values" though, I think those could maybe be one per line. But that's a separate issue. (average measure) |