docs: replace experimental disclaimers with pre-v1 warnings

[jdx]

Summary

• replace experimental and do-not-use disclaimers with pre-v1 compatibility warnings
• clarify that interfaces, configuration, storage formats, and behavior are not finalized
• mark the documentation as unreviewed AI-generated material that will be reviewed and finished later
• align crate metadata, Rust docs, contributor guidance, and release-note guidance with the new wording

Why

The project should communicate its pre-v1 status and potential for breaking changes without describing itself as experimental.

Validation

• mise run ci
• mise run docs:check
• git diff --check

---

Note

Low Risk
Documentation and metadata-only changes with no runtime, config, or storage logic touched.

Overview
Reframes user-facing messaging from “experimental / do not use” to pre-v1: CLI, configuration, storage format, and behavior are not finalized and breaking changes may land between releases.

The README caution box, VitePress home/guide pages, AGENTS.md tone guidance, communique.toml release-note instructions, tak-cli crate description, Rust crate docs, and asset-picker README all use the same pre-v1 wording. Several doc callouts now also state that the docs are unreviewed AI-generated material to be finished later. Hyperfine/Bencher/CodSpeed remain the suggested stable alternatives; hostile “go away” / “do not file issues” language is removed.

^{Reviewed by Cursor Bugbot for commit 3fa3b63. Bugbot is set up for automated code reviews on this repo. Configure here.}

Summary by CodeRabbit

• Documentation
  • Updated project messaging to identify tak as pre-v1 software.
  • Clarified that the command-line interface, configuration, storage format, and behavior may change between releases.
  • Added notices that documentation is AI-generated, unfinished, and not fully reviewed.
  • Refreshed guidance across the README, website, getting-started materials, experiment guide, and crate documentation.
  • Retained recommendations for established benchmarking and performance-tracking alternatives.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: b0a098f8-8229-4595-91ee-972ba4a3df2b

📥 Commits

Reviewing files that changed from the base of the PR and between 6097eaa and 3fa3b63.

📒 Files selected for processing (10)

• AGENTS.md
• Cargo.toml
• README.md
• communique.toml
• crates/asset-picker/README.md
• docs/guide/experiment.md
• docs/guide/getting-started.md
• docs/index.md
• src/lib.rs
• src/main.rs

---

📝 Walkthrough

Walkthrough

The changes replace “experimental” and “do not use” notices with consistent pre-v1 warnings across project guidance, metadata, README pages, crate documentation, and configuration.

Changes

Pre-v1 status messaging

Layer / File(s)	Summary
Project guidance and metadata AGENTS.md, Cargo.toml, communique.toml	Contributor guidance, package metadata, and project configuration now describe pre-v1 interfaces, configuration, storage, and behavior.
User documentation warnings README.md, docs/guide/*, docs/index.md	User-facing pages now state that changes may be incompatible and identify unfinished, AI-generated documentation where applicable.
Crate documentation notices crates/asset-picker/README.md, src/lib.rs, src/main.rs	Crate and binary notices now state that pre-v1 interfaces and behavior may change.

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

Possibly related PRs

• jdx/tak#28: Updates overlapping documentation warnings in the guide and homepage.

Poem

A rabbit reads the warning bright,
“Pre-v1 changes may take flight!”
Interfaces hop, configs run,
Storage shifts beneath the sun.
“Keep docs reviewed,” says Bunny White.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[greptile-apps]

Greptile Summary

This PR consistently replaces the project’s experimental and do-not-use language with pre-v1 compatibility warnings.

• Clarifies that CLI interfaces, configuration, storage formats, APIs, and behavior may change incompatibly.
• Adds notices that the documentation is AI-generated and has not yet been fully reviewed.
• Aligns crate metadata, Rust module documentation, contributor guidance, and release-note guidance with the revised status language.

Confidence Score: 5/5

The PR appears safe to merge because it changes only documentation and descriptive metadata, with consistent pre-v1 messaging throughout.

The changes do not alter runtime logic, configuration parsing, persisted formats, dependencies, or build behavior, and no concrete defects were identified.

Important Files Changed

Filename	Overview
README.md	Replaces the experimental disclaimer with a clear pre-v1 warning while retaining stable-tool alternatives.
docs/guide/experiment.md	Updates the status warning and adds the requested documentation-review disclaimer without changing technical guidance.
docs/guide/getting-started.md	Reframes installation guidance around expected pre-v1 breaking changes and flags the documentation as unreviewed.
docs/index.md	Updates the homepage tagline and warning to consistently describe the project as pre-v1.
Cargo.toml	Revises package metadata to describe the crate as pre-v1 without affecting build or dependency behavior.
communique.toml	Adjusts release-note generation guidance to require explicit treatment of breaking changes without experimental framing.
AGENTS.md	Aligns contributor-facing tone guidance with the new compatibility warning and release-note expectations.
crates/asset-picker/README.md	Replaces the dependency discouragement with a focused pre-v1 API and behavior compatibility warning.
src/lib.rs	Updates crate-level documentation only; no library behavior or public exports change.
src/main.rs	Updates binary-level documentation only; CLI behavior remains unchanged.

_{Reviews (1): Last reviewed commit: "docs: replace experimental disclaimers w..." | Re-trigger Greptile}