Ruby-doc.org has been updated

Ruby-doc.org has been updated.

New rdoc template.

New site style.

Disqus commenting for rdocs.

No doubt there are bugs, issues, problems; please contact me directly if
you find something amiss.

There’s more to do but I wanted to get out something that was bette than
what has there while I get on to fixing other things.

James B.

[email protected]

The new styling is a nice. And no more frames, definite upgrade!

Adding class/method search was a much-needed feature. Thank you.
Issues on the http://ruby-doc.org/core/ page:

  1. Methods filter is failing on searches for any of the methods equal
    to or starting with “<” or “>”.

  2. Although the method filter is snappy on the first search, it then
    needs 30-90 seconds to do anything else, even update from a single
    character backspace or permit the browser to do page reload. (On my
    Chrome/OSX, anyway. Anyone else seeing experiencing this?). The
    class/module filter does not share this issue.

Matt N. wrote:

At a first glance, looks great.

I’d love to see a links-to-online-tutorials section (as opposed to the
printed books section on the one hand, and the “presentations” on the
other). Of course this is mostly because I’d like to see a link to my
online tutorial:

http://www.apeth.com/rubyIntro/justenoughruby.html

I can do that; it has to go on my growing todo list, though.

The current set of non-API doc links and files is a bit dated.

I’d appreciate suggestions on additions/changes to what tutorials and
such to link to or host.

James B.

[email protected]

James B. [email protected] wrote:

There’s more to do but I wanted to get out something that was bette than
what has there while I get on to fixing other things.

At a first glance, looks great.

I’d love to see a links-to-online-tutorials section (as opposed to the
printed books section on the one hand, and the “presentations” on the
other). Of course this is mostly because I’d like to see a link to my
online tutorial:

http://www.apeth.com/rubyIntro/justenoughruby.html

:slight_smile:

m.

Hmm. Why isn’t Etc listed among the Class/Module selector? It’s part
of core for 1.9.x, right?

Answering my own question: it’s a standard library, not core.

It’d be nice if the site could offer the core page’s list/filter
feature for (core+stdlib). The people most in need of documentation
are least likely to know which stuff to lookup on the core section of
the site vs stdlib section. “Not found” will translate to “ruby
doesn’t have that” or “go find a gem” in many a newcomer’s mind.

Carina C. Zona wrote:

The new styling is a nice. And no more frames, definite upgrade!

You’d might be surprised that some people miss them. (I don’t.)

Adding class/method search was a much-needed feature. Thank you.
Issues on the http://ruby-doc.org/core/ page:

  1. Methods filter is failing on searches for any of the methods equal
    to or starting with “<” or “>”.

Ah. :frowning:

I’ll have to see what’s up with that.

  1. Although the method filter is snappy on the first search, it then
    needs 30-90 seconds to do anything else, even update from a single
    character backspace or permit the browser to do page reload. (On my
    Chrome/OSX, anyway. Anyone else seeing experiencing this?). The
    class/module filter does not share this issue.

Work is being done on this. It is slow, especially on Chrome.

Thanks for the feedback.

James

Anyone complaining about missing their beloved frames is free to do
this to double up on their frame satisfaction:

  • http://www.ruby-doc.org/stdlib/
  • click on any package name in the left frame
  • click on 'Stdlib" link at top of right frame
  • yay for them, duplicated left frame!

Ahhh, the fond memories of why we took frames out to the pasture and
shot them some time back around the turn of the millenium…

Carina C. Zona wrote:

Anyone complaining about missing their beloved frames is free to do
this to double up on their frame satisfaction:

  • http://www.ruby-doc.org/stdlib/
  • click on any package name in the left frame
  • click on 'Stdlib" link at top of right frame
  • yay for them, duplicated left frame!

:slight_smile:

That needs to go.

James

James B. wrote in post #1024816:

Ruby-doc.org has been updated.

awesome! nice work - an overhaul was much needed…

  • j

Nice.

I’m kind-of missing the “oldschool” look ;), but the search was really
needed. Good job.

– Matma R.

On Tue, Oct 4, 2011 at 2:42 AM, James B. [email protected]
wrote:

Ruby-doc.org has been updated.

great. clean. the very nice icon/logo now stands out =)

2011/10/7 Bartosz Dziewoński [email protected]:

I’m kind-of missing the “oldschool” look ;), but the search was really
needed. Good job.

speaking of old school. it’s a lot friendlier now w text browsers :slight_smile:

On 03.10.2011 20:42, James B. wrote:

Ruby-doc.org has been updated.

Great work, much needed, thanks a lot!

On browsers which dynamically show/hide their scrollbar (i.e. FF) the
page “jumps” in the following case:

  1. got to http://ruby-doc.org/stdlib/libdoc/socket/rdoc/index.html
  2. observe page is long due long list of methods
  3. enter “z” in the methods filter

the page “jumps” as the scrollbar gets hidden because there’s no content
to show.

  • Markus

On Mon, Oct 3, 2011 at 1:42 PM, James B. [email protected]
wrote:

There’s more to do but I wanted to get out something that was bette than
what has there while I get on to fixing other things.

[Replying on the list since everyone else is doing it – apologies.]

It looks very nice. However, a few bad things stand out:

  1. I always have to scroll horizontally. I’m probably more picky about
    keeping my browser size fixed (and non-maximized) than most people; so
    at my preferred browser size, the content doesn’t fit horizontally.
    Even when I maximize it, it doesn’t quite fit, since I have a wide
    taskbar at the left edge. When I hide my taskbar and maximize the
    browser, I can see all of the content except for a few code examples
    that run off the edge (for example, the code in
    instance_variable_set(symbol, obj) → obj under Object); there is still
    a horizontal scrollbar.

(I’m seeing this with more and more sites these days, so it might be
that designers don’t worry about fitting horizontal space anymore, and
I need to adjust. But I’d rather not :slight_smile: )

  1. I’m a little on the fence about this one, but ultimately I’d prefer
    the text color to be black for non-focused text as well as focused.
    The gray background around focused text is enough to make it stand
    out; the gray text sort of looks like something my brain should ignore
    (which might be good for some people, but I’d like to be able to
    comfortably read the descriptions of all the methods without moving my
    cursor).

  2. When you type in a filter term under Classes, the area containing
    the classes shrinks, causing the method area to come over to the left.
    It would be nicer if it stayed the same size. (As an aside: it might
    be nice if the list of methods automatically got narrowed down to just
    methods available in the classes found by the filter.)

  3. Another one I’m on the fence about: put certain very common classes
    up at the top (and then show them again in alphabetical order). I’m
    not sure how to decide which classes get listed at the top, but
    certainly Object should. (Ultimately, maybe there could be an optional
    tree view of class relationships.)

  4. It would be nice to have filtering of methods, etc. on the class
    pages.

  5. Maybe link to RXR instead of raw source.

I’m excited to see how the discussions work out.

Someone else mentioned that you get frames if you click stdlib along
the top; is that just linking to an old version of the site?

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

On 10/3/11 8:42 PM, James B. wrote:

Ruby-doc.org has been updated.

New rdoc template.

New site style.

Disqus commenting for rdocs.

It is really amazing!

The class and method searchfilter are great and very useful.
I am looking forward to have the same style applied for stdlib.
(without frameset)

Thanks all that were involved!


all the best sandor
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.11 (Darwin)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iQIcBAEBCgAGBQJOjz/ZAAoJEIiuFRwovs5rgZAP/R7MNC/t2ijIsQVNKJT1k9yd
mDZjoKEo5vd7N319sKXT8U12n4tIKG0588+WtMD4kM3WdOvgyXa0l3BLiyVTQl9v
8xIdZ7Q0SXlaa8Lh+pw21Cc0Mzgpg+TXVGsv3Yh0S7/VX+BirxraOP38L52smXQf
fM4m5LoAMCS8+eQe00wRRT2piA3mujkCIm5+f6xuJCWR7W/x3c0y/xwCPEiENRTR
0Y3V/nebn4OOLBKuPukJDec4cm2eMj+n/dmlBrlPx9JaLIuGKvDYhbm7CiaJsWgh
irYkOSH0bpm51ieoh7x3TnIhJtOaWq9ICEJdIEHCgpasBPWf6k/m1WYlcswaNgwc
Hi40KxR5K+Jt+OXrmeh9Q0NnSCamFQULiZsV0S3V96FXmQfi90wKCQxtP1ssyNJW
fEEiRZFDy8ddPJIRbaAkRSYqOyIjMzA19InYYLQz78TQEIFb1HFC0lA0+W8fDcn6
C43BGc0pfAZTj5DT9nGLpQqhXbngSw7X1m88RhDcQJfq0cVCp6cieXB7Z9BPpXo8
gc8tT2GKWfLlPhi5yuc9UQOAqv+VJFfH3QGjUmX/OeAwfTYfaNJOzAqOS5zSrgsT
J4K6yjXHmHwVRKpXsbIOc2sXHtLHBdH0113zdDlLObyb5G2PyEkRB/Wq3Depq//B
gTkkIsOLMrlmTg8wcAxO
=tYyg
-----END PGP SIGNATURE-----

Eric C. wrote:

[Replying on the list since everyone else is doing it – apologies.]

Short-term OK, long-term, not the best way to get my attention since I
don’t usually follow the list that closely anymore.

It looks very nice. However, a few bad things stand out:

  1. I always have to scroll horizontally. I’m probably more picky about
    keeping my browser size fixed (and non-maximized) than most people; so
    at my preferred browser size, the content doesn’t fit horizontally.

What size is good for you?

Even when I maximize it, it doesn’t quite fit, since I have a wide
taskbar at the left edge. When I hide my taskbar and maximize the
browser, I can see all of the content except for a few code examples
that run off the edge (for example, the code in
instance_variable_set(symbol, obj) → obj under Object); there is still
a horizontal scrollbar.

OK.

(I’m seeing this with more and more sites these days, so it might be
that designers don’t worry about fitting horizontal space anymore, and
I need to adjust. But I’d rather not :slight_smile: )

I generally assume 960px or so is reasonable.

  1. I’m a little on the fence about this one, but ultimately I’d prefer
    the text color to be black for non-focused text as well as focused.

I’m looking at adding switchable stylyesheets since for every
light-on-dark fan there’s a dark-on-light fan, etc. So, if nothing
else, offering an obvious high-contrast style would be useful to a
number of people.

methods available in the classes found by the filter.)
Work is in progress on the JavaScript (thanks, Phrogz!) The
method-reduction is part of that (which is a very good idea).

  1. Another one I’m on the fence about: put certain very common classes
    up at the top (and then show them again in alphabetical order). I’m
    not sure how to decide which classes get listed at the top, but
    certainly Object should. (Ultimately, maybe there could be an optional
    tree view of class relationships.)

The main index needs work. It follows a pattern that works OK for a
single gem or library, but not so OK for a massive set of classes.

I may steal the arrangement used by the default YARD template.

  1. It would be nice to have filtering of methods, etc. on the class pages.

Isn’t that there? if you click on the icon next to “Class/Module index”
it should open a search box.

Perhaps that’s not entirely obvious …

  1. Maybe link to RXR instead of raw source.

I’m excited to see how the discussions work out.

Someone else mentioned that you get frames if you click stdlib along
the top; is that just linking to an old version of the site?

I kept the old layout for that for assorted reasons, but that needs more
attention. I didn’t want to keep putting off what updates I already
had, waiting until everything was Just So. I’d never be done. :slight_smile:

It’s a work in progress, and the feedback is welcome.

Thanks,

James B.

On Sat, 8 Oct 2011 01:51:38 +0900
James B. [email protected] wrote:

I’m looking at adding switchable stylyesheets

This is remarkably easy with a combination of css, javascript and
cookies.

I borrowed some code from a few sources, and you can see it in action
on http://spiralofhope.com with the top-right ‘styles’. Feel free to
dig into and copy any code.

If I can help with this, let me know.

On Oct 7, 2011, at 09:51 , James B. wrote:

I generally assume 960px or so is reasonable.

Don’t assume that. For example, my ipad has 1024-by-768 and I usually
read nerd doco in portrait, not landscape. A fluid layout would be much
preferred for all devices.

On Fri, Oct 7, 2011 at 4:00 PM, Ryan D. [email protected]
wrote:

On Oct 7, 2011, at 09:51 , James B. wrote:

I generally assume 960px or so is reasonable.

Don’t assume that. For example, my ipad has 1024-by-768 and I usually read nerd
doco in portrait, not landscape. A fluid layout would be much preferred for all
devices.

+1. Not just for all devices; also for the varied needs of all users
of any single device.

I often find line lengths too long for quick skimming, so adjust
window size accordingly. Others choose to increase content size to
compensate for sub-optimal near vision. Others like to use wide
screens to multi-view windows rather than maximize. etc.

For a design heavily reliant on graphics, establishing a minimum width
is sometimes a necessary evil. But this one is delightfully texty
enough that I think it’s safe to skip that.

By the way, the fixed height on home’s header is forcing overlap
w/content when screen width narrows to mobile-ish sizes.

This forum is not affiliated to the Ruby language, Ruby on Rails framework, nor any Ruby applications discussed here.

| Privacy Policy | Terms of Service | Remote Ruby Jobs