Skip to content

docs: fill README gaps for staging features - #579

Merged
biodrone merged 1 commit into
stagingfrom
docs/staging-readme-gaps
Jul 4, 2026
Merged

docs: fill README gaps for staging features#579
biodrone merged 1 commit into
stagingfrom
docs/staging-readme-gaps

Conversation

@biodrone

@biodrone biodrone commented Jul 4, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Expand Post-Download Script Hook docs: executable requirement, live+VOD coverage, STREAMDL_POST_SCRIPT_TIMEOUT, and Docker volume mount example
  • Add Tick Notices section explaining the --- notices --- log block and deduplication behavior
  • Fix README link to config/config.yml.example and add a commented post_script line to the example config

Test plan

  • Docs-only change; no code or CI impact
  • Review README renders correctly on GitHub

Made with Cursor

Document hook timeout/executable requirements, tick notice output, fix
the example config path, and add post_script to config.yml.example.

Co-authored-by: Cursor <cursoragent@cursor.com>
@coderabbitai

coderabbitai Bot commented Jul 4, 2026

Copy link
Copy Markdown

Warning

Review limit reached

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

Next review available in: 36 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 7f3b6901-dad2-4ad2-8966-bf52fb778d77

📥 Commits

Reviewing files that changed from the base of the PR and between 0f40fba and 017f08b.

📒 Files selected for processing (2)
  • README.md
  • config/config.yml.example
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/staging-readme-gaps

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.

@biodrone
biodrone merged commit 7e52b34 into staging Jul 4, 2026
8 checks passed
@biodrone
biodrone deleted the docs/staging-readme-gaps branch July 4, 2026 06:08
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