State the Pythons CI tests, and read them rather than typing them by arpanghoshal · Pull Request #1 · CTRLRun/ctrlrun-docs

arpanghoshal · 2026-09-10T22:50:28Z

What

Readiness block (README block, docs home, production page): Python 3.11 and later. becomes Python 3.11 and later, tested on 3.11 to 3.14.
render_readiness.py no longer types the Python sentence. It reads the floor from the library's requires-python and the tested list from the library's CI check matrix, and --check compares both, so a version added to or dropped from that matrix drifts this block until it is regenerated. It refuses a floor CI does not test, a non->=3.N requires-python, and an unquoted matrix entry (YAML reads 3.10 as the float 3.1).
Install page: one sentence saying CI runs the full suite on 3.11, 3.12, 3.13 and 3.14.

generated/readiness.json gains only the python field. The recorded test count is unchanged: --write re-counts with whatever is installed locally, and a count taken with the adapter frameworks installed would exceed what CI collects and fail the floor check.

Depends on CTRLRun/ctrlrun#134

This PR's CI reads the library's main. Until #134 (which adds 3.13 and 3.14 to the matrix) is merged, render_readiness.py --check here reports python changed since the block was generated, which is the check doing its job. Re-run CI after #134 merges.

Checked locally, against the #134 branch

scripts/check.sh: ruff format, ruff check, 1566 passed
lint.py, links.py, and all nine render_*.py --check: 0 drift
Mutation: restoring the old sentence in docs/production/index.mdx makes render_readiness.py --check report readiness block differs.

🤖 Generated with Claude Code

Summary by CodeRabbit

Documentation
- Updated version and installation guidance to state that CTRLRun 0.6.1 supports Python 3.11 and later.
- Clarified that the full test suite runs on Python 3.11 through 3.14.
Maintenance
- Documentation readiness checks now generate Python-version information from project and CI configuration, helping detect outdated documentation.

The readiness block said "Python 3.11 and later" as a literal. It now says "Python 3.11 and later, tested on 3.11 to 3.14", with the floor read from the library's requires-python and the tested list from its CI check matrix, so adding or dropping a version there drifts this block until it is regenerated. A floor CI does not test is refused. The install page says which Pythons CI runs the suite on. Only the new python field was added to generated/readiness.json; the recorded test count is unchanged.

mintlify · 2026-09-10T22:50:30Z

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated
ctrlrun	🟢 Ready	View Preview	Sep 10, 2026, 10:51 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

coderabbitai · 2026-09-10T22:50:50Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 27e63b79-cf1d-4892-99f2-45a2089ab559

📥 Commits

Reviewing files that changed from the base of the PR and between 949aebe and 1f474e3.

⛔ Files ignored due to path filters (4)

generated/readiness.full.mdx is excluded by !**/generated/**
generated/readiness.json is excluded by !**/generated/**
generated/readiness.mdx is excluded by !**/generated/**
generated/readiness.readme.md is excluded by !**/generated/**

📒 Files selected for processing (4)

docs.mdx
docs/get-started/install.mdx
docs/production/index.mdx
tools/docs_audit/render_readiness.py

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

📝 Walkthrough

Walkthrough

The readiness audit now reads the Python requirement and tested CI versions from project configuration. It generates the Python support sentence, checks documentation drift, and updates three documentation pages to state testing on Python 3.11 through 3.14.

Changes

Python support documentation

Layer / File(s)	Summary
Python metadata pipeline `tools/docs_audit/render_readiness.py`	`_python()` reads and validates the Python floor and CI test matrix. `measure()` includes the resulting Python metadata.
Documentation rendering and drift checks `tools/docs_audit/render_readiness.py`, `docs.mdx`, `docs/get-started/install.mdx`, `docs/production/index.mdx`	The renderer generates the Python support sentence, drift checks include Python metadata, and documentation states testing on Python 3.11 through 3.14.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 1f474

This PR only changes how Python support documentation is generated and displayed, deriving the supported version range from project configuration and CI instead of hardcoding it. No unresolved functional or dependency issues were found in review, so this change is low risk and ready to merge.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 57.14% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 7 functions across 1 files. (3 skipped: 3…	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 accurately describes the main change: document the Python versions tested by CI and derive those versions instead of hardcoding them.
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 57.14% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 7 functions across 1 files. (3 skipped: 3 unsupported.)

Fix all pre-merge checks with AI

✨ 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 docs/python-3.13-3.14

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.}

mintlify Bot deployed to staging September 10, 2026 22:51 View deployment

Navigation Menu

Uh oh!

State the Pythons CI tests, and read them rather than typing them - #1

State the Pythons CI tests, and read them rather than typing them#1
arpanghoshal wants to merge 1 commit into
mainfrom
docs/python-3.13-3.14

arpanghoshal commented Sep 10, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

mintlify Bot commented Sep 10, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Sep 10, 2026 •

edited

Loading

Walkthrough

Changes

❌ Failed checks (1 warning)

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

arpanghoshal commented Sep 10, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

Depends on CTRLRun/ctrlrun#134

Checked locally, against the #134 branch

Summary by CodeRabbit

Uh oh!

mintlify Bot commented Sep 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Sep 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

❌ Failed checks (1 warning)

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

arpanghoshal commented Sep 10, 2026 •

edited by coderabbitai Bot

Loading

mintlify Bot commented Sep 10, 2026 •

edited

Loading

coderabbitai Bot commented Sep 10, 2026 •

edited

Loading