Replace frames based implementation with a frames-like css implementa… #137
Conversation
|
The build is failing because rubygems can't be upgraded for deprecated ruby versions. This has been fixed by #134. |
|
A rails example can be found here: http://deheus.net/rdoc/ |
|
@sunny Thanks and done :) The biggest blocker I think is that the side panel collapse when clicking an item. |
|
I think I can solve the side panel stuff as well.. |
…tion The current Rails documentation has a frames based implementation. This prevents deep linking to documentation and removes navigation if the page is opened without frames. We can keep the same layout with a css based implementation.
|
It now also opens the panel for the current page. For example: |
|
Neat! I honestly don't know how hard this would be, so I'll just write some words, and feel free to jump to a quick "no": Do you think it would be possible (either now, or in the future) to make this do a turbolinks-y replacement of the content on the right without replacing the leftnav at all? I can't speak for others, but I find I often click quickly between several opened nodes to compare two entries, or to find exactly which I need -- especially when navigating search results. Having the navigation pre-expanded is much better than it re-collapsing, but it does still feel less friendly than something that seems truly persistent. (While totally acknowledging all the disadvantages of frames, and reasons this otherwise is a very good idea.) |
|
@matthewd I think that would be possible with turbolinks and |
p8
force-pushed
the
without-frames
branch
2 times, most recently
from
d0619ed
to
4c5d4a0
Compare
|
@matthewd I have a proof of concept working with turbolinks. |
By abandoning frames the side panel no longer persists after clicking on links in the panel. With turbolinks we can make the panel persistent across requests by setting data-turbolinks-permanent attribute on the panel. Generated pages can be in multiple sub directories so we link to the assets with relative urls. Turbolinks does not consider relative urls similar, resulting in page reloads and losing the context of the panel. This has been fixed by making the assets urls absolute. This breaks opening the docs locally. Maybe all generated docs should be in the same folder? This change also upgrade jQuery to 3.5.1. Removes ie hack
…tion
The current Rails documentation has a frames based implementation. This
prevents deep linking to documentation and removes navigation if the page
is opened without frames.
We can keep the same layout with a css based implementation.
Fixes #135