Skip to content

docs: mark public release live#6

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

docs: mark public release live#6
Dhruv2mars merged 1 commit intomainfrom
docs/published-status

Conversation

@Dhruv2mars
Copy link
Owner

Summary

  • update repo docs to reflect public npm and release availability
  • update docs contract tests to match the published state

Verify

  • bun run --filter @dhruv2mars/codexchat test
  • bun run check
  • npm install @dhruv2mars/codexchat
  • npx codexchat --help

@Dhruv2mars Dhruv2mars merged commit ad67358 into main Mar 20, 2026
10 of 11 checks passed
@Dhruv2mars Dhruv2mars deleted the docs/published-status branch March 20, 2026 08:15
@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: 2d3b8a33-5a35-4af0-ae15-bc6f2c708e58

📥 Commits

Reviewing files that changed from the base of the PR and between ea166e4 and 2b12c91.

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

📝 Walkthrough

Walkthrough

This pull request updates documentation and tests to reflect the publication status of the npm package and GitHub release assets. The root README.md and packages/cli/README.md are modified to remove "not published yet" language and adjust installation guidance accordingly. Installation instructions are simplified from conditional "when published" phrasing to direct usage guidance. Local development instructions are explicitly reframed as such. The documentation-contract tests are updated to assert the presence of "npm package is published" and "GitHub release assets are published" phrases while removing assertions for pre-release command paths.

✨ 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/published-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