Skip to content

docs: add commit now and going live during a timeout to the knowledge base - #1212

Open
sulimanbenhalim wants to merge 5 commits into
dev-null-sh:productionfrom
sulimanbenhalim:docs/kb-commit-now-and-live
Open

sulimanbenhalim wants to merge 5 commits into
dev-null-sh:productionfrom
sulimanbenhalim:docs/kb-commit-now-and-live

Conversation

@sulimanbenhalim

@sulimanbenhalim sulimanbenhalim commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Changes

  • the scheduled commits paragraph says a queued post can be canceled or submitted right away with Commit now which counts against the same 10 per minute limit and its sources link ScheduledCommitSubmissionController.php
  • the timeout paragraph lists going live with the other things a timeout blocks and says a stream that is already live keeps showing and End stream still works

Validation

  • checked against the code and the tests of feat: commit a scheduled commit now #1136 and fix: stop people in timeout from going live #1146: scheduled-commit-submission.store submits the queued commit into the usual review process behind ThrottleCommits and PreventPostingInTimeout while user-live.update has PreventPostingInTimeout and user-live.destroy doesn't and CreateUserTimeout never ends a stream
  • the full gate passed on the first revision (4529 tests with 100% coverage) and the final one only adds two sentences to KNOWLEDGE_BASE.md which no test reads and lint still passes
  • bun run test:unit has one failure that production already has since 80cca8f4 (fix: pooling)

Independent review

  • read-only Claude agent: CODE PASS on base e83d7c04 head a8ee050f checking each sentence against the controllers and middleware and tests

Limitations

  • None

Summary by CodeRabbit

  • Documentation
    • Added table-of-contents links for related commits, organization calls, and mobile apps.
    • Updated guidance on refreshing profile READMEs, discovering organizations, and starting or ending streams.
    • Documented immediate commit scheduling and the updated location of the commit-sharing menu.
    • Clarified SSH key syncing, timeout restrictions, and which organization-authored commits remain after account deletion.
    • Updated the achievements tab label and descriptions of AI services, embeddings, and knowledge-base search.

@coderabbitai

coderabbitai Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • Resume reviews
  • Trigger review

No actionable comments were generated in the recent review.

Walkthrough

The knowledge base adds and revises descriptions of product features, commit actions, SSH-key setup, account restrictions, and AI services.

Changes: Knowledge base updates

Layer / File(s) Summary
Product feature documentation
KNOWLEDGE_BASE.md
The contents and feature descriptions cover related commits, organization calls, mobile apps, profile README refresh, organization discovery, live controls, and the achievements tab label.
Commit actions
KNOWLEDGE_BASE.md
The scheduled-commits page documents immediate submission and its shared 10-per-minute limit. Commit-sharing instructions identify the commit’s … menu and the Copy link action.
SSH keys and account actions
KNOWLEDGE_BASE.md
The documentation updates GitHub SSH-key synchronization, retained organization commits after account deletion, and actions restricted during a timeout.
AI services and search
KNOWLEDGE_BASE.md
The documentation describes OpenAI use for embeddings, relevance checks, moderation, tool selection, and knowledge-base query embeddings.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Suggested reviewers: paulinevos, mnapoli

Merge Risk: Minimal · previous review 457b6

This PR updates documentation for commit actions, timeout restrictions, SSH key syncing and AI services. It has no runtime effect, and no merge-blocking issues were found.

Architecture risk: Low · up to d5c10

The change affects 1 system.

Changed systems: KNOWLEDGE_BASE.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — KNOWLEDGE_BASE.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in KNOWLEDGE_BASE.md: Adds Related commits to the Features contents list.
  • observed — Modified behavior in KNOWLEDGE_BASE.md: Adds Remotes: org calls to the Features contents list.
  • observed — Modified behavior in KNOWLEDGE_BASE.md: Adds Mobile apps to the Features contents list.
  • observed — Modified behavior in KNOWLEDGE_BASE.md: Adds that a developer can refresh their GitHub profile README immediately with Sync from GitHub; the previous description specified daily refresh only.
Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title names two documentation additions, 'commit now' and 'going live during a timeout'. The raw summary confirms KNOWLEDGE_BASE.md documents scheduling commits immediately and going live as a tim…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title names two documentation additions, 'commit now' and 'going live during a timeout'. The raw summary confirms KNOWLEDGE_BASE.md documents scheduling commits immediately and going live as a timeout-blocked action, which matches the title. The title is concise, specific, and follows the conventional 'docs:' prefix. It does not mention the many other stale-content corrections (table of contents, SSH key sync, account deletion, AI services), so it covers only part of the changeset, but that is acceptable because the title need not cover every detail.

Finishing Touches

Generate unit tests (beta)

  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: b080586d-65cd-4502-892a-1451157b0aab
Commits

Reviewing files that changed from the base of the PR and between 28fc185 and 457b6a6.

Files selected for processing: 1

  • KNOWLEDGE_BASE.md
Files skipped from review as they are similar to previous changes: 1

  • KNOWLEDGE_BASE.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 1 remain after this review.

@paulinevos

Copy link
Copy Markdown
Contributor

Can you do another run on this to see if anything else is stale? And rebase lol

@sulimanbenhalim
sulimanbenhalim force-pushed the docs/kb-commit-now-and-live branch from 27eb635 to d5c10e1 Compare November 3, 2026 22:13
@sulimanbenhalim

Copy link
Copy Markdown
Contributor Author

rebased onto production and went through the whole thing against the code
more had drifted so those are fixed too

  • Contents was missing Related commits and Remotes: org calls and Mobile apps
  • going live is its own button on your profile or "go live" in search now and the card says Watch now
  • the commit Share menu became the … menu in feat: move commit actions into a menu, with follow, mute, block and delete #1371
  • the ranks tab is Unix Ranks
  • timeouts also block pings and starting or joining calls
  • deleting your account keeps the commits you posted as an org along with their images
  • org pages also come from bios and companies and Sync from GitHub refreshes the README right away
  • the terminal and the action only know keys from sign in or Sync from GitHub (or a recheck at most every 5 minutes when you post with a key it already knows)
  • the AI row still said search embeddings go through the Laravel AI SDK and linked the removed app/Services/OpenAI.php

one thing I left alone: Mobile apps says you can link an Apple ID on iOS but I couldn't find anything for it on the server yet so not sure if that line is just ahead of a PR

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.

2 participants