Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace frames based documentation with css #36011

Closed
wants to merge 1 commit into from
Closed

Replace frames based documentation with css #36011

wants to merge 1 commit into from

Conversation

p8
Copy link
Member

@p8 p8 commented Apr 17, 2019

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.

I've created a pull request for sdoc which replaces the frames with a css based
solution without changing in the layout.
https://github.com/zzak/sdoc/pull/137

This pull request temporarily changes the Gemfile to point to my branch (it would be nice to have better documentation for Rails 6 and Railsconf).

…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.
@p8 p8 changed the title Replace frames based implementation with a frames-like css implementation Replace frames based documentation with css Apr 17, 2019
@eileencodes eileencodes requested a review from fxn April 18, 2019 19:41
@fxn
Copy link
Member

fxn commented Apr 19, 2019

Hey! Thanks a lot for this, it has been a long standing inconvenience in the API.

To make things orderly, I'd prefer to see first what @zzak thinks about it, and whether it is merged upstream. Before that, I prefer not to point to a branch here.

Do you have a sample of how does the API look like with your solution?

@p8
Copy link
Member Author

p8 commented Apr 19, 2019

Great! I'll see if I can upload it somewhere.

@p8
Copy link
Member Author

p8 commented Apr 19, 2019

Not sure if I'm running the sdoc command correctly (there's more files than I expected), but this it what it look like now: http://deheus.net/rdoc/
I'd like to add opening the panel to the current selected page, but haven't got that working yet.

@p8
Copy link
Member Author

p8 commented Apr 19, 2019

Ok let's see if can run it with rake rdoc.

@fxn
Copy link
Member

fxn commented Apr 19, 2019

If you get the rails-dev-box and clone the Rails project in its root directory in the host, in principle it would be just

host$ vagrant up
host$ vagrant ssh

guest$ cd /vagrant/rails
guest$ bundle install
guest$ bundle exec rake rdoc

(off the top of my head).

@fxn
Copy link
Member

fxn commented Apr 19, 2019

That looks pretty cool BTW!

@rails-bot
Copy link

rails-bot bot commented Dec 18, 2019

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.
Thank you for your contributions.

@rails-bot rails-bot bot added the stale label Dec 18, 2019
@rails-bot rails-bot bot closed this Dec 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants