Skip to content

Commit

Permalink
Replace frames-based api docs with css implementation and Turbolinks
Browse files Browse the repository at this point in the history
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.

Turbolinks is used to persisted the navigation/search bar across
requests.
  • Loading branch information
p8 committed Oct 16, 2020
1 parent 4194565 commit edff559
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ group :rubocop do
end

group :doc do
gem "sdoc", "~> 1.1"
gem "sdoc", github: "p8/sdoc", branch: "without-frames"
gem "redcarpet", "~> 3.2.3", platforms: :ruby
gem "w3c_validators", "~> 1.3.6"
gem "kindlerb", "~> 1.2.0"
Expand Down
12 changes: 9 additions & 3 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ GIT
event_emitter
websocket

GIT
remote: https://github.com/p8/sdoc.git
revision: a5e95cafdebf8a76ea21f2237e6349223f9ecac5
branch: without-frames
specs:
sdoc (1.1.0)
rdoc (>= 5.0)

GIT
remote: https://github.com/resque/redis-namespace.git
revision: c31e63dc3cd5e59ef5ea394d4d46ac60d1e6f82e
Expand Down Expand Up @@ -461,8 +469,6 @@ GEM
sprockets (> 3.0)
sprockets-rails
tilt
sdoc (1.1.0)
rdoc (>= 5.0)
selenium-webdriver (3.142.7)
childprocess (>= 0.5, < 4.0)
rubyzip (>= 1.2.2)
Expand Down Expand Up @@ -612,7 +618,7 @@ DEPENDENCIES
rubocop-performance
rubocop-rails
sass-rails
sdoc (~> 1.1)
sdoc!
selenium-webdriver (>= 3.141.592)
sequel
sidekiq
Expand Down

0 comments on commit edff559

Please sign in to comment.