[EDU-1984] - Create Laravel getting started guide #2730

GregHolmes · 2025-07-22T13:50:53Z

Description

Laravel getting started guide for Pub/Sub. Using Laravel 12.

coderabbitai · 2025-07-22T13:50:59Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch EDU-1984-Create-Laravel-getting-started-guide

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

sacOO7 · 2025-07-30T13:38:52Z

src/pages/docs/getting-started/laravel.mdx

+```
+</Code>
+
+## Step 6: Create a frontend file to listen for events <a id="step-6"/>


Including the css file is unnecessary—it distracts the user and shifts focus away from the main content of the documentation.

It would be helpful to include a screenshot from https://github.com/ably-labs/laravel-broadcast-app to demonstrate that we have a functioning app and provide an instant display of broadcaster capabilities.

sacOO7

link to https://github.com/ably-labs/laravel-broadcast-app missing

sacOO7 · 2025-07-30T13:46:29Z

src/pages/docs/getting-started/laravel.mdx

@@ -0,0 +1,484 @@
+---
+title: "Getting started: Pub/Sub in Laravel"


Suggested change

title: "Getting started: Pub/Sub in Laravel"

title: "Getting started: Laravel broadcasting using ably"

The current integration of Ably with Laravel no longer reflects a traditional pub/sub pattern.
At the same time, Laravel section under the "Pub/Sub" category is somewhat misleading, as it doesn’t expose any of the core pub/sub APIs.

Instead, it’s built on top of pub/sub—similar to other higher-level products like Chat, LiveSync, and LiveObjects. It offers a full-fledged integration specifically tailored to Laravel and Laravel Echo, exposing framework-specific APIs. I would recommend avoiding the pubsub term in any of the ably laravel documentation, it's misleading for number of reasons : |

Consider moving this guide to a top-level section, as it aligns more closely with a dedicated Laravel integration than with generic pub/sub functionality. Or better, if we can have a separate page for the same, since none of the pubsub template is compatible with it.

sacOO7 · 2025-07-30T13:54:17Z

src/pages/docs/getting-started/laravel.mdx

+* Revisit the basics of [Pub/Sub](/docs/pub-sub?lang=php)
+* Explore more [advanced](/docs/pub-sub/advanced?lang=php) Pub/Sub concepts
+* Read more about how to use [presence](/docs/presence-occupancy/presence?lang=php) in your apps
+* Fetch message [history](/docs/storage-history/history?lang=php) in your apps
+* Learn about [Laravel Broadcasting](https://laravel.com/docs/broadcasting) with Ably


Suggested change

* Revisit the basics of [Pub/Sub](/docs/pub-sub?lang=php)

* Explore more [advanced](/docs/pub-sub/advanced?lang=php) Pub/Sub concepts

* Read more about how to use [presence](/docs/presence-occupancy/presence?lang=php) in your apps

* Fetch message [history](/docs/storage-history/history?lang=php) in your apps

* Learn about [Laravel Broadcasting](https://laravel.com/docs/broadcasting) with Ably

* Read ably laravel doc at [Ably laravel broadcaster github](https://github.com/ably/laravel-broadcaster)

* Read ably laravel echo at [Ably laravel echo github](https://github.com/ably-forks/laravel-echo)

* Try running our [ably laravel chat app](https://github.com/ably-labs/laravel-broadcast-app)

* Learn more about [Laravel Broadcasting](https://laravel.com/docs/broadcasting)

GregHolmes force-pushed the EDU-1984-Create-Laravel-getting-started-guide branch from 8f75a8f to bd8ce26 Compare July 22, 2025 13:52

GregHolmes self-assigned this Jul 22, 2025

GregHolmes added the review-app Create a Heroku review app label Jul 22, 2025

GregHolmes requested review from sacOO7 and m-hulbert July 22, 2025 13:52

ably-ci temporarily deployed to ably-docs-edu-1984-crea-csiibz July 22, 2025 13:52 Inactive

GregHolmes changed the title ~~Edu 1984 create laravel getting started guide~~ [EDU-1984] - Create Laravel getting started guide Jul 22, 2025

GregHolmes force-pushed the EDU-1984-Create-Laravel-getting-started-guide branch from bd8ce26 to 327b2ea Compare July 24, 2025 13:06

GregHolmes temporarily deployed to ably-docs-edu-1984-crea-csiibz July 24, 2025 13:07 Inactive

GregHolmes had a problem deploying to ably-docs-edu-1984-crea-csiibz July 24, 2025 13:17 Failure

GregHolmes temporarily deployed to ably-docs-edu-1984-crea-csiibz July 24, 2025 13:27 Inactive

GregHolmes added 3 commits July 28, 2025 12:24

Add Laravel getting started guide

73e98c1

Add Laravel getting started guide

2ac0d7b

Migrate Laravel getting started guide from textile to mdx

962aecb

GregHolmes force-pushed the EDU-1984-Create-Laravel-getting-started-guide branch from 1bd0528 to 962aecb Compare July 28, 2025 11:24

GregHolmes temporarily deployed to ably-docs-edu-1984-crea-csiibz July 28, 2025 11:25 Inactive

fixup! Migrate Laravel getting started guide from textile to mdx

d872455

GregHolmes temporarily deployed to ably-docs-edu-1984-crea-csiibz July 28, 2025 11:44 Inactive

sacOO7 reviewed Jul 30, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[EDU-1984] - Create Laravel getting started guide #2730

[EDU-1984] - Create Laravel getting started guide #2730

Uh oh!

GregHolmes commented Jul 22, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jul 22, 2025 •

edited

Loading

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

sacOO7 Jul 30, 2025 •

edited

Loading

Uh oh!

sacOO7 Jul 30, 2025

Uh oh!

sacOO7 left a comment •

edited

Loading

Uh oh!

sacOO7 Jul 30, 2025 •

edited

Loading

Uh oh!

sacOO7 Jul 30, 2025

Uh oh!

sacOO7 Jul 30, 2025

Uh oh!

Uh oh!

		@@ -0,0 +1,484 @@
		---
		title: "Getting started: Pub/Sub in Laravel"

	title: "Getting started: Pub/Sub in Laravel"
	title: "Getting started: Laravel broadcasting using ably"

[EDU-1984] - Create Laravel getting started guide #2730

Are you sure you want to change the base?

[EDU-1984] - Create Laravel getting started guide #2730

Uh oh!

Conversation

GregHolmes commented Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

coderabbitai bot commented Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

sacOO7 Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sacOO7 Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

sacOO7 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sacOO7 Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sacOO7 Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

sacOO7 Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

GregHolmes commented Jul 22, 2025 •

edited

Loading

coderabbitai bot commented Jul 22, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

sacOO7 Jul 30, 2025 •

edited

Loading

sacOO7 left a comment •

edited

Loading

sacOO7 Jul 30, 2025 •

edited

Loading