Skip to content

docs: compress README first-run path#689

Merged
EffortlessSteven merged 1 commit into
mainfrom
docs/readme-first-run-path
May 15, 2026
Merged

docs: compress README first-run path#689
EffortlessSteven merged 1 commit into
mainfrom
docs/readme-first-run-path

Conversation

@EffortlessSteven

@EffortlessSteven EffortlessSteven commented May 15, 2026

Copy link
Copy Markdown
Member

Summary

  • Rewrites the README opening around user jobs and copyable first commands.
  • Adds quick CLI discovery and webhook bundle/verify commands above the deeper proof-system sections.
  • Keeps public claim proof visible as a metadata-only verification-pack path with explicit non-claims.
  • Advances the active goal: readme-first-run is done and user-path-smoke is ready.

Files added/changed

  • README.md
  • .uselesskey/goals/active.toml

Validation

  • cargo xtask docs-sync --check
  • cargo xtask typos
  • cargo xtask badges --check
  • git diff --check

Non-goals

  • No new README badges.
  • No new fixture families, public claims, contract packs, proof commands, release work, or dependency churn.
  • No removal of deeper README/reference material; this only compresses the first-run path.

What this enables next

  • Next PR: xtask: add user-path smoke checks.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented May 15, 2026

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, add credits to your account and enable them for code reviews in your settings.

@coderabbitai

coderabbitai Bot commented May 15, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@EffortlessSteven has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 35 minutes and 6 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: a2687b6d-6b78-4619-ac0f-3d6ecb59b56a

📥 Commits

Reviewing files that changed from the base of the PR and between 2384310 and 10d1377.

📒 Files selected for processing (2)
  • .uselesskey/goals/active.toml
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-first-run-path

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 and usage tips.

@gemini-code-assist

gemini-code-assist Bot commented May 15, 2026

Copy link
Copy Markdown

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

@EffortlessSteven EffortlessSteven merged commit db11f37 into main May 15, 2026
5 checks passed
@EffortlessSteven EffortlessSteven deleted the docs/readme-first-run-path branch May 15, 2026 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@EffortlessSteven