Skip to content

docs: Add language-specific README.md files for JavaScript and Rust #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
konard merged 5 commits into from
Jan 11, 2026
Merged

docs: Add language-specific README.md files for JavaScript and Rust #118

konard merged 5 commits into from
Jan 11, 2026

Conversation

@konard
Copy link
Contributor

@konard konard commented Jan 11, 2026 •
edited
Loading

Summary

This PR adds separate language-specific README.md files for the JavaScript and Rust implementations, while updating the root README.md to serve as a common entry point for both.

Key Change (addressing feedback)

No documentation content was deleted - all previously existing docs have been preserved by moving them to the appropriate language-specific README:

  • js/README.md now contains all the detailed documentation that was in the original root README
  • rust/README.md contains Rust-specific documentation
  • README.md (root) serves as a common entry point with links to both implementations

Changes

  • js/README.md - Comprehensive npm-specific documentation including:

    • Full security warning and feature list
    • Installation with Bun
    • Complete usage examples (model selection, session resume, etc.)
    • Full CLI options reference
    • JSON output standards (OpenCode and Claude formats)
    • Input formats documentation
    • Complete MCP documentation (Playwright tools, configuration)
    • Key Features section (No Config Required, OpenCode 100% Compatible)
    • JSON Event Streaming Output examples
    • Development workflow (dev mode, testing, linting)
    • Publishing with Changesets
    • Why Bun-only explanation
    • Project structure overview
    • Architecture details

  • rust/README.md - Cargo-specific documentation including:

    • Current implementation status (WIP)
    • List of implemented features (7 tools)
    • Build and development instructions
    • Project structure overview
    • JSON output format examples

  • README.md (root) - Updated to be a common entry point:

    • Overview of both implementations with feature comparison
    • Quick links to language-specific docs with summary of what they contain
    • Common features and architecture
    • Documentation links table

  • js/package.json - Updated files array to include js/README.md instead of ../README.md so npm package gets the JavaScript-specific README

  • js/.changeset/language-specific-readme.md - Changeset for version bump

Test Plan

  • Linting passes (npm run lint)
  • Format checks pass (npm run format:check)
  • All links in README files are valid
  • JS CI checks pass
  • Rust CI checks pass
  • Working tree is clean (no uncommitted changes)
  • Branch is based on latest main
  • All original documentation content preserved (moved, not deleted)

Related

Fixes #117

🤖 Generated with Claude Code

@konard
Initial commit with task details
919c448 
Adding CLAUDE.md with task information for AI processing.
This file will be removed when the task is complete.

Issue: #117
@konard konard self-assigned this Jan 11, 2026
@konard @claude
docs: Add language-specific README.md files for JavaScript and Rust
f36bc53 
- Create js/README.md with npm-specific documentation (installation,
  development, publishing, project structure)
- Create rust/README.md with cargo-specific documentation (build,
  development, implemented features, status)
- Update root README.md to be common for both implementations with
  links to language-specific docs
- Update js/package.json to include js/README.md for npm package

Fixes #117

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@konard konard changed the title [WIP] Ensure JavaScript and Rust version have separate language specific README.md files docs: Add language-specific README.md files for JavaScript and Rust Jan 11, 2026
@konard @claude
chore: Add changeset for language-specific README files
4146833 
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@konard konard marked this pull request as ready for review January 11, 2026 00:30
@konard
Copy link
Contributor Author

konard commented Jan 11, 2026

🤖 Solution Draft Log

This log file contains the complete execution trace of the AI solution draft process.

💰 Cost estimation:

  • Public pricing estimate: $4.220322 USD
  • Calculated by Anthropic: $2.712526 USD
  • Difference: $-1.507796 (-35.73%)
    📎 Log file uploaded as GitHub Gist (525KB)
    🔗 View complete solution draft log

Now working session is ended, feel free to review and add any feedback on the solution draft.

@konard
Copy link
Contributor Author

konard commented Jan 11, 2026

Lots of docs content was deleted, we cannot just delete docs content, we can move it, but not totally delete it. It contains accumulated knowledge.

@konard konard marked this pull request as draft January 11, 2026 00:41
@konard
Copy link
Contributor Author

konard commented Jan 11, 2026

🤖 AI Work Session Started

Starting automated work session at 2026-01-11T00:41:17.638Z

The PR has been converted to draft mode while work is in progress.

This comment marks the beginning of an AI work session. Please wait working session to finish, and provide your feedback.

@konard @claude
docs: Preserve all documentation content in language-specific READMEs
6dfa1f5 
Address feedback that documentation content was deleted: all previously
existing docs content has been moved to js/README.md instead of being
removed. The js/README.md now includes:

- Full security warning with emojis
- Complete feature list with checkmarks
- All usage examples (model selection, session resume, etc.)
- Full CLI options reference
- JSON output standards (OpenCode and Claude formats)
- Input formats documentation
- Complete MCP documentation (Playwright tools, configuration)
- Key Features section (No Config Required, OpenCode 100% Compatible)
- JSON Event Streaming Output examples
- Development, Testing, and Publishing sections
- Why Bun-only explanation
- Architecture details

The root README.md serves as a common entry point with links to
language-specific documentation, while preserving all essential
information about the project.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@konard
Copy link
Contributor Author

konard commented Jan 11, 2026

Addressed Feedback

Thank you for the feedback about the deleted documentation content. I've updated the PR to address this concern:

All documentation content has been preserved - nothing was deleted, just moved to the appropriate location:

What changed:

  1. js/README.md now contains all the detailed documentation that was previously in the root README, including:

    • Full security warning with emojis
    • Complete feature list with checkmarks
    • All usage examples (model selection, session resume, direct prompt mode)
    • Full CLI options reference
    • JSON output standards (OpenCode and Claude formats)
    • Input formats documentation
    • Complete MCP documentation with all 22+ Playwright tools
    • Key Features section (No Configuration Required, OpenCode 100% Compatible, Plain Text Support, JSON Event Streaming Output)
    • Development, Testing, and Publishing sections
    • Why Bun-only explanation
    • Architecture details

  2. README.md (root) serves as a common entry point with:

    • Overview of both implementations
    • Quick start examples
    • Links to detailed language-specific documentation

  3. rust/README.md has Rust-specific documentation (unchanged)

Summary of additions:

  • js/README.md: +446 lines (from 199 to 619 lines) - all original content preserved
  • README.md: minor formatting improvements and better cross-references

All CI checks pass (JS lint, format, Rust checks).

@konard konard marked this pull request as ready for review January 11, 2026 00:48
@konard
Copy link
Contributor Author

konard commented Jan 11, 2026

🤖 Solution Draft Log

This log file contains the complete execution trace of the AI solution draft process.

💰 Cost estimation:

  • Public pricing estimate: $2.855208 USD
  • Calculated by Anthropic: $1.736881 USD
  • Difference: $-1.118328 (-39.17%)
    📎 Log file uploaded as GitHub Gist (445KB)
    🔗 View complete solution draft log

Now working session is ended, feel free to review and add any feedback on the solution draft.

@konard konard merged commit 6b1536c into main Jan 11, 2026
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@konard konard

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Ensure JavaScript and Rust version have separate language specific README.md files

2 participants

@konard