Skip to content

docs: clarify public release status#4

Merged
Dhruv2mars merged 1 commit intomainfrom
docs/public-status
Mar 20, 2026
Merged

docs: clarify public release status#4
Dhruv2mars merged 1 commit intomainfrom
docs/public-status

Conversation

@Dhruv2mars
Copy link
Owner

Summary

  • make README and package docs state that npm and GitHub releases are not live yet
  • add source-run fallback until first public release
  • keep docs-contract tests aligned with the new public status

Verify

  • bun run --filter @dhruv2mars/codexchat test
  • npm view @dhruv2mars/codexchat version returned 404 on 2026-03-20
  • gh release list returned empty on 2026-03-20

@Dhruv2mars Dhruv2mars merged commit 799f1a7 into main Mar 20, 2026
10 of 11 checks passed
@Dhruv2mars Dhruv2mars deleted the docs/public-status branch March 20, 2026 07:29
@coderabbitai
Copy link

coderabbitai bot commented Mar 20, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2ee342cf-cd32-47b4-a330-22b445fa7baa

📥 Commits

Reviewing files that changed from the base of the PR and between c8df869 and 38472e5.

📒 Files selected for processing (3)
  • README.md
  • packages/cli/README.md
  • packages/cli/test/docs-contract.test.js

📝 Walkthrough

Walkthrough

The changes update installation and setup documentation across the repository. The root README.md and packages/cli/README.md now include a dated public status section (March 20, 2026) indicating that the npm package and GitHub release assets are not yet published. Both README files document an alternative workflow using bun install and cargo run -p codexchat-cli -- for running the CLI from source. The test file packages/cli/test/docs-contract.test.js was updated to include assertions verifying these documentation changes are present in the README files.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/public-status
📝 Coding Plan
  • Generate coding plan for human review comments

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.

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