mirrors
/
rails
mirror of https://github.com/rails/rails
8
0
Fork 0
Code Issues Projects Releases Wiki Activity
rails/actioncable
History
Petrik 8565f45100 Use relative includes of README's in documentation [ci-skip] 
The Rails documentation uses the `:include:` directive to inline the
README of the framework into the main documentation page. As the
README's aren't in the root directory from where SDoc is run we need to
add the framework path to the include:

    # :include: activesupport/README.md

This results in a warning when installing the gems as generating the rdoc for the gem is run from the gem/framework root:

    Couldn't find file to include 'activesupport/README.rdoc' from lib/active_support.rb

The `:include:` RDoc directive supports includes relative to the current
file as well:

    # :include: ../README.md

This makes sure it works for the Rails API docs and the separate gems.

Co-authored-by: Jonathan Hefner <jonathan@hefner.pro>
 		2024-01-18 10:39:15 +01:00
..
app Fix self is undefined for actioncable within ssr build systems by replacing it globalThis 2024-01-03 19:19:50 +00:00
bin Use frozen string literal in actioncable/ 2017-07-23 23:30:29 +03:00
lib Use relative includes of README's in documentation [ci-skip] 2024-01-18 10:39:15 +01:00
test Rename `#assert_not_has_stream` `#assert_has_no_stream` 2024-01-05 11:29:21 +09:00
.babelrc Convert ActionCable javascript to ES2015 modules with modern build environment 2018-11-02 08:41:05 -07:00
.eslintrc Output Action Cable JS without transpiling and as ESM (#42856) 2021-08-06 14:00:43 +02:00
.gitignore Ensure @rails/actioncable package contains complete source 2019-08-15 09:19:59 -04:00
CHANGELOG.md Rename `#assert_not_has_stream` `#assert_has_no_stream` 2024-01-05 11:29:21 +09:00
MIT-LICENSE Remove Copyright years (#47467) 2023-02-23 11:38:16 +01:00
README.md 🔗 Remove RDoc auto-link from Rails module everywhere 2023-06-23 10:49:30 +09:00
Rakefile Load framework test files in deterministic order 2019-12-16 16:55:06 +00:00
actioncable.gemspec Bump the required Ruby version to 3.1.0 2023-12-31 08:54:03 +01:00
karma.conf.js Output Action Cable JS without transpiling and as ESM (#42856) 2021-08-06 14:00:43 +02:00
package.json Development of Rails 7.2 starts now 2023-09-27 03:59:11 +00:00
rollup.config.js Output Action Cable JS without transpiling and as ESM (#42856) 2021-08-06 14:00:43 +02:00
rollup.config.test.js Output Action Cable JS without transpiling and as ESM (#42856) 2021-08-06 14:00:43 +02:00

README.md

Action Cable – Integrated WebSockets for \Rails

Action Cable seamlessly integrates WebSockets with the rest of your \Rails application. It allows for real-time features to be written in Ruby in the same style and form as the rest of your \Rails application, while still being performant and scalable. It's a full-stack offering that provides both a client-side JavaScript framework and a server-side Ruby framework. You have access to your full domain model written with Active Record or your ORM of choice.

You can read more about Action Cable in the Action Cable Overview guide.

Support

API documentation is at:

Bug reports for the Ruby on \Rails project can be filed here:

Feature requests should be discussed on the rails-core mailing list here: