Skip to content

docs: centralize SDK examples in official docs #171

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.

Sign up for GitHub

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

Merged
marandaneto merged 1 commit into from
Jun 12, 2026
+14 −162
Merged

docs: centralize SDK examples in official docs #171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
142 changes: 0 additions & 142 deletions EXAMPLE_SETUP.md
View file
Open in desktop

This file was deleted.

23 changes: 8 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,17 @@

Please see the main [PostHog docs](https://posthog.com/docs).

Specifically, the [Ruby integration](https://posthog.com/docs/integrations/ruby-integration) details.
SDK usage examples and code snippets live in the official documentation so they stay up to date.

> [!IMPORTANT]
> **Use a single client instance (singleton)** — Create the PostHog client once and reuse it throughout your application. Multiple client instances with the same API key can cause dropped events and inconsistent behavior. The SDK will log a warning if it detects multiple instances. For Rails apps, use `PostHog.init` in an initializer (see [posthog-rails](posthog-rails/README.md)).
## Documentation

> [!IMPORTANT]
> Supports Ruby 3.2 and above
>
> We will lag behind but generally not support versions which are end-of-life as listed here https://www.ruby-lang.org/en/downloads/branches/
>
> All 2.x versions of the PostHog Ruby library are compatible with Ruby 2.0 and above if you need Ruby 2.0 support.

## Rails Integration

**Using Rails?** Check out [posthog-rails](posthog-rails/README.md) for automatic exception tracking, ActiveJob instrumentation, and Rails-specific features.
- [Ruby library docs](https://posthog.com/docs/libraries/ruby)
- [Ruby on Rails framework docs](https://posthog.com/docs/libraries/ruby-on-rails)

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for local setup, example, and test instructions.
See [CONTRIBUTING.md](CONTRIBUTING.md) for local setup and test instructions.

## Releasing

For release instructions, see [RELEASING.md](RELEASING.md).
See [RELEASING.md](RELEASING.md).
11 changes: 6 additions & 5 deletions posthog-rails/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# PostHog Rails
# PostHog Ruby on Rails

Official PostHog integration for Ruby on Rails applications.
Please see the main [PostHog docs](https://posthog.com/docs).

For installation, configuration, usage, and troubleshooting, see the official documentation:
SDK usage examples and code snippets live in the official documentation so they stay up to date.

https://posthog.com/docs/libraries/ruby-on-rails
## Documentation

Keeping usage docs in one place avoids stale examples in this repository.
- [Ruby on Rails framework docs](https://posthog.com/docs/libraries/ruby-on-rails)
- [Ruby library docs](https://posthog.com/docs/libraries/ruby)
Loading