Fubu docs readability

60 views
Skip to first unread message

Kevin Miller

unread,
May 16, 2013, 11:29:05 AM5/16/13
to fubumv...@googlegroups.com
Hate to pick on the docs in any way as I am so happy to see some documentation appearing, but I felt it important to give some feed back on my impression of the fubudocs. I wanted to comment on the typography and structure of the ripple docs.

Typography:

* Fonts are quite small I find my browser is at 150% to make them readable. 
* The main font is again small with contrast between its color and the background is small. I have to strain to read text for any period of time. 
* The topic header font is very narrow making it difficult to read. 

Most of this could be related to the tired eyes of this here poster. But I am possibly not alone.

Structure: 

* There seems to be very little content on each page. I find myself having click through many pages while reading. I think most users don't mind scrolling. Just do what GitHub does and provide lots of inline anchors to make it easy to link withing long pages. 
* When I get to the bottom of the page I have to go to the top left of the page to find the next page button. One should be right there at the bottom ready for me. 
* Navigation : I had some more thoughts but at the moment GitHub just went down and I can't view the docs. So I'll stop here. :)

Github is down for me so I'll stop here because I have whined enough. Happy to help with the codes if you need it.

KevM 

Joshua Arnold

unread,
May 16, 2013, 11:52:43 AM5/16/13
to fubumv...@googlegroups.com
You're right about the typography, Kevin. That was an out-of-the-box theme that I bought so you're not hurting my feelings here. I've since bumped up the font-size to try and help with that but we might reconsider the font face.

Regarding the "very little content on each page", that's a problem that *I think* is isolated to the ripple docs because this poster didn't do a great job at actually documenting ripple. I was mostly using it as a way to test out FubuDocs and get "something" out there.

Regarding the bottom of the page/navigation problem, the breadcrumb/navigation bar at the top is "Sticky" and follows you while you scroll. It's *always* there so the next/previous buttons are always available for you. I thought that would be enough?

Keep the feedback coming. I definitely appreciate it.


--
You received this message because you are subscribed to the Google Groups "FubuMVC Development Group" group.
To unsubscribe from this group and stop receiving emails from it, send an email to fubumvc-deve...@googlegroups.com.
To post to this group, send email to fubumv...@googlegroups.com.
Visit this group at http://groups.google.com/group/fubumvc-devel?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.
 
 

Matthew Smith

unread,
May 16, 2013, 11:57:44 AM5/16/13
to fubumv...@googlegroups.com
I would agree with Kevin about the page navigation being available at the bottom of the page. My eyes are already at the bottom of the screen while reading, so that would only seem natural to me. 

Joshua Arnold

unread,
May 16, 2013, 11:59:47 AM5/16/13
to fubumv...@googlegroups.com
We can duplicate the links. The other outstanding item is to make the left sidebar "affixed" and have it scroll with you (like the top navigation does). That would definitely help as well.

Jeremy Miller

unread,
May 16, 2013, 12:10:52 PM5/16/13
to fubumv...@googlegroups.com
For anybody coming in late to this discussion, see http://darthfubumvc.github.io/ripple/ripple/ for an example of what the fubudocs styling and layout looks like right now.

Joshua Arnold

unread,
May 16, 2013, 12:11:46 PM5/16/13
to fubumv...@googlegroups.com


--

Kevin Miller

unread,
May 17, 2013, 4:57:16 PM5/17/13
to fubumv...@googlegroups.com
Thank you Steve. Let me know if I can help. 

Sent from my portable orbiting headquarters.


On Thu, May 16, 2013 at 1:37 PM, Steve Matney <steve....@gmail.com> wrote:

A couple of people on our team felt like the theming could definitely be tightened up when we saw it initially, as well, so I'm planning on doing some work to that end this week. Initially, it's going to be mostly layout work (some of those ui elements are super wonky), but while I'm in there I can definitely take a look at some of the stuff Kevin's mentioned.



On Thursday, May 16, 2013 9:29:05 AM UTC-6, KevM wrote:

Reply all
Reply to author
Forward
0 new messages