Skip to content

README: nothing commercial, and the documentation links go to docs.ctrlrun.dev - #187

Merged
rohanrkamath merged 3 commits into
mainfrom
readme/launch-sync
Sep 13, 2026
Merged

rohanrkamath merged 3 commits into
mainfrom
readme/launch-sync

Conversation

@arpanghoshal

@arpanghoshal arpanghoshal commented Sep 13, 2026

Copy link
Copy Markdown
Member

Follow-up to #185, which merged before this landed on its branch.

  • The tiers section, the early-access and engagement links, the interactive walkthrough links and the closing slogan are the site's material and not the library's; they go.
  • Every documentation link uses https://docs.ctrlrun.dev/, which serves each page under ctrlrun.dev/docs at the same path (every link in the file was probed). The three badges that point at pages are regenerated from the docs repository's generator, on CTRLRun/ctrlrun-docs spec: amend v0.3 against an independent review of §4 and §5 #21, rather than edited by hand; merge that PR right after this one so render_badges.py --check agrees on both sides.
  • The tests that pinned the old URLs follow: test_repository_signals, test_verify_action, test_readme_assets.

Run locally: 350 kernel tests across the README-adjacent files green; docs-side render_badges --check 0 drifted, lint 0, links 0 broken, README snippets 0 failed, test_home_and_readme_agree green against this branch.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated README links and badges to use the new documentation site at docs.ctrlrun.dev.
    • Replaced the standalone execution-boundary link with a broader documentation navigation table.
    • Removed the Open Source/Pro/Enterprise section and closing slogan from the README.
  • Tests
    • Updated README checks to validate the new documentation URLs and revised content.

…rlrun.dev

The tiers section, the early-access and engagement links, the interactive walkthrough
links and the closing slogan are the site's material and not the library's; they go. The
documentation is docs.ctrlrun.dev, which serves every page under ctrlrun.dev/docs at the
same path, so every documentation link uses that host, including the three badges that
point at pages, which are regenerated from the docs repository's generator rather than
edited here. The tests that pinned the old URLs follow.

Signed-off-by: arpan <contact@arpanghoshal.com>
Signed-off-by: arpan <contact@arpanghoshal.com>
@coderabbitai

coderabbitai Bot commented Sep 13, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: b34a7a52-96c4-463d-8dbc-293ad6237c46

📥 Commits

Reviewing files that changed from the base of the PR and between 22bacd3 and 7f3843f.

📒 Files selected for processing (4)
  • README.md
  • tests/test_readme_assets.py
  • tests/test_repository_signals.py
  • tests/test_verify_action.py

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The README now uses docs.ctrlrun.dev links and an expanded documentation index. Commercial sections and the closing call-to-action were removed. Tests were updated for the new URLs and README content.

Changes

Documentation Link Migration

Layer / File(s) Summary
README documentation updates
README.md
Documentation links now use docs.ctrlrun.dev. The README includes an expanded categorized documentation index and no longer includes the standalone execution-boundary link, commercial section, or closing call-to-action.
README test alignment
tests/test_readme_assets.py, tests/test_repository_signals.py, tests/test_verify_action.py
Tests now assert the updated documentation URLs. The removed HOMEPAGE_CLOSE constant and its README assertion were also removed.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to e8e79

The README migration and its tests are aligned, with no established merge-blocking risk remaining.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 60.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 5 functions across 3 files. (1 skipped: 1… Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the two main changes: removing commercial README content and updating documentation links to docs.ctrlrun.dev.
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: Docstring Coverage

Explanation

Docstring coverage is 60.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 5 functions across 3 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch readme/launch-sync

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.

@rohanrkamath
rohanrkamath merged commit 73a1f29 into main Sep 13, 2026
15 of 16 checks passed
@rohanrkamath
rohanrkamath deleted the readme/launch-sync branch September 13, 2026 22:29
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