Skip to content

chore(docs): align product documentation - #440

Merged
yordis merged 3 commits into
masterfrom
yordis/chore-consolidate-documentation-updates
Jul 16, 2026
Merged

chore(docs): align product documentation#440
yordis merged 3 commits into
masterfrom
yordis/chore-consolidate-documentation-updates

Conversation

@yordis

@yordis yordis commented Jul 16, 2026

Copy link
Copy Markdown
Member
  • Keeps the documentation focused on the local FOSS distribution instead of stale release and proprietary-feature guidance.
  • Reduces operator confusion around supported install, protocol, auth, telemetry, and diagnostics surfaces.
  • Consolidates deferred documentation cleanup into one reviewable pass without copying external release notes.

Signed-off-by: Yordis Prieto <yordis.prieto@gmail.com>
@cursor

cursor Bot commented Jul 16, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Documentation-only changes with no server code in the diff; risk is limited to operator confusion if any removed commercial guidance was still relied on elsewhere.

Overview
This PR realigns the documentation with the TrogonDB FOSS distribution: EventStoreDB/Event Store Cloud/commercial references are replaced with TrogonEventStore and TrogonDB, and prose that described proprietary plugins and paid features is removed or reframed.

The docs hub (docs/README.md) now states explicit product direction: gRPC for application events, HTTP for Admin UI, health, metrics, and probes (/-/liveness, /-/readiness, /-/metrics), and that rich read models and projection runtimes belong outside the node unless decided otherwise.

Installation is rewritten around building from source, local --dev runs, and Docker builds from the repo instead of PackageCloud/Chocolatey/Event Store downloads, with a shorter production checklist.

Across operations/diagnostics pages, several behavior corrections appear: Monitoring.Stats as fresh memoized node stats (not persisted stats events), stats stream TTL 10 days, persistent subscription checkpoint/parked stream naming, projection reset/epoch and reserved stream table, archive requiring a read-only Archiver replica, replication TLS tied to DisableTls, and read-only replicas excluded from ClusterSize. Networking drops external TCP client plugin documentation; logs drop commercial log-download API in favor of filesystem/container collection.

Reviewed by Cursor Bugbot for commit 8a23ac6. Bugbot is set up for automated code reviews on this repo. Configure here.

@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@yordis, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 25 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 35290be4-3b7f-4b36-849c-01f44a778e1c

📥 Commits

Reviewing files that changed from the base of the PR and between 5f5022a and 8a23ac6.

📒 Files selected for processing (25)
  • README.md
  • docs/README.md
  • docs/admin-ui.md
  • docs/cluster.md
  • docs/configuration.md
  • docs/db-config.md
  • docs/diagnostics/README.md
  • docs/diagnostics/integrations.md
  • docs/diagnostics/logs.md
  • docs/diagnostics/metrics.md
  • docs/indexes.md
  • docs/installation.md
  • docs/networking.md
  • docs/operations.md
  • docs/package.json
  • docs/persistent-subscriptions.md
  • docs/projections.md
  • docs/security.md
  • docs/server-settings.md
  • docs/streams.md
  • docs/upgrade-guide.md
  • docs/usage-telemetry.md
  • docs/whatsnew.md
  • samples/server/docker-compose-cluster.yaml
  • samples/server/docker-compose.yaml
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch yordis/chore-consolidate-documentation-updates

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

Comment @coderabbitai help to get the list of available commands.

yordis added 2 commits July 16, 2026 15:48
Signed-off-by: Yordis Prieto <yordis.prieto@gmail.com>
Signed-off-by: Yordis Prieto <yordis.prieto@gmail.com>
@yordis
yordis merged commit 6079ffd into master Jul 16, 2026
3 checks passed
@yordis
yordis deleted the yordis/chore-consolidate-documentation-updates branch July 16, 2026 22:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant