Skip to content

docs: replace experiment framing - #37

Merged
jdx merged 2 commits into
mainfrom
agent/rename-experiment
Aug 1, 2026
Merged

jdx merged 2 commits into
mainfrom
agent/rename-experiment

Conversation

@jdx

@jdx jdx commented Aug 1, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • rename the methodology guide and route
  • replace “the experiment” wording across the README and documentation
  • update site metadata to describe tak as pre-v1 deterministic CLI benchmarking

This removes the old experimental framing now that it no longer matches how tak should describe itself. Existing /guide/experiment links are intentionally not preserved.

Validation

  • npm run docs:build
  • verified the repository contains no remaining uses of experiment

AI-generated.


Note

Low Risk
Documentation and routing copy only; no runtime or benchmark logic changes, with intentional breakage of old /guide/experiment links.

Overview
Reframes tak’s public docs from an experimental narrative to a methodology-focused one, without changing product behavior.

The guide at /guide/experiment is renamed to Methodology at /guide/methodology (old URL is not redirected). README, VitePress nav/sidebar, and the docs home page now point to that route and use a “Why instruction counts” section title instead of “The experiment.” Site and Open Graph descriptions drop “half-baked experiment” in favor of deterministic CLI benchmarking with instruction counts.

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

@coderabbitai

coderabbitai Bot commented Aug 1, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

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

Next review available in: 52 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: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 0feff090-31d1-4c79-9127-4928d9ade4b1

📥 Commits

Reviewing files that changed from the base of the PR and between 672657d and 4aac0ea.

📒 Files selected for processing (4)
  • README.md
  • docs/.vitepress/config.mts
  • docs/guide/methodology.md
  • docs/index.md

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.

@greptile-apps

greptile-apps Bot commented Aug 1, 2026 •

Copy link
Copy Markdown

Greptile Summary

Renames the documentation’s experiment framing to methodology and updates the site’s description.

  • Moves the methodology guide from /guide/experiment to /guide/methodology.
  • Updates README, navigation, sidebar, homepage actions, and feature links to use the new terminology and route.
  • Replaces the experimental site metadata with deterministic CLI benchmarking language.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
README.md Renames the explanatory section and updates its guide link to the methodology route.
docs/.vitepress/config.mts Updates site metadata and navigation entries to reflect the methodology terminology and route.
docs/guide/methodology.md Renames the existing experiment guide and changes its heading to Methodology.
docs/index.md Updates homepage calls to action and feature links to target the renamed methodology guide.

Reviews (2): Last reviewed commit: "docs: refine site description" | Re-trigger Greptile

greptile-apps[bot]
greptile-apps Bot previously approved these changes Aug 1, 2026
@greptile-apps
greptile-apps Bot dismissed their stale review August 1, 2026 23:45

Dismissed because a newer commit was pushed; Greptile will re-review the current head.

@jdx
jdx enabled auto-merge (squash) August 1, 2026 23:46
@jdx
jdx merged commit 33b4196 into main Aug 1, 2026
10 checks passed
@jdx
jdx deleted the agent/rename-experiment branch August 1, 2026 23:47
@jdx jdx mentioned this pull request Aug 1, 2026
jdx added a commit that referenced this pull request Aug 3, 2026
## 🤖 New release

* `asset-picker`: 0.0.1 -> 0.0.2 (✓ API compatible changes)
* `tak-cli`: 0.0.5 -> 0.0.6 (✓ API compatible changes)

<details><summary><i><b>Changelog</b></i></summary><p>

## `asset-picker`

<blockquote>

## [0.0.2](https://github.com/jdx/tak/compare/0.0.1..0.0.2) - 2026-08-02

### 📚 Documentation

- replace experimental disclaimers with pre-v1 warnings by
[@jdx](https://github.com/jdx) in
[#34](#34)

<!-- generated by git-cliff -->
</blockquote>

## `tak-cli`

<blockquote>

## [0.0.6](https://github.com/jdx/tak/compare/0.0.5..0.0.6) - 2026-08-02

### 🚀 Features

- make the runner class a setting by [@jdx](https://github.com/jdx) in
[#25](#25)

### 📚 Documentation

- add the tak documentation site by [@jdx](https://github.com/jdx) in
[#28](#28)
- replace experimental disclaimers with pre-v1 warnings by
[@jdx](https://github.com/jdx) in
[#34](#34)
- explain project adoption by [@jdx](https://github.com/jdx) in
[#35](#35)
- replace experiment framing by [@jdx](https://github.com/jdx) in
[#37](#37)

### 🔍 Other Changes

- lock communique, so a release stops needing a human by
[@jdx](https://github.com/jdx) in
[#26](#26)

<!-- generated by git-cliff -->
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/release-plz/release-plz/).

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Low Risk**
> Version and changelog-only changes; no application logic modified in
this PR.
> 
> **Overview**
> **Automated release** via release-plz: bumps **`tak-cli`** from
`0.0.5` to **`0.0.6`** and workspace crate **`asset-picker`** from
`0.0.1` to **`0.0.2`**, with matching updates in **`Cargo.lock`** and
the path dependency version in root **`Cargo.toml`**.
> 
> Adds git-cliff **changelog** entries for **0.0.6** (root) and
**asset-picker 0.0.2**, documenting already-merged work— notably
**runner class as a setting**, docs site and pre-v1 messaging, and
**communique** lockfile changes—without introducing new runtime code in
this diff.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
be8b102. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
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