docs: add CHANGELOG.md and update README with installation troublesho…

[CoderSerio]

…oting and changelog reference

Description

Type of change

• New API or feature
• Bug fix
• Documentation
• Refactor / chore
• Other (please describe):

Checklist

• New .rs file under src/ (if adding an API)
• Module registered in src/lib.rs (if adding an API)
• pnpm build:debug passes with no warnings
• Tests in __test__/ (functional + parity with node:fs + error cases, if applicable)
• pnpm test passes
• README.md and README.zh-CN.md Roadmap updated (if API or behavior change)
• Benchmark added and results included (if adding/changing performance-sensitive API)

See CONTRIBUTING.md for the full development guide.

Summary by CodeRabbit

• Documentation

  • Introduced CHANGELOG.md documenting project versions, features, and fixes following standard conventions
  • Enhanced README with platform-specific native binding installation instructions for macOS, Windows, and Linux
  • Added release checklist guidance for maintainers in contributing documentation
  • Added Chinese language documentation support

• Chores

  • Updated release workflow for improved package publishing

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
rush-fs-docs	Building	Preview, Comment	Feb 21, 2026 4:09am

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

This PR adds comprehensive release documentation and adjusts the GitHub Actions workflow timing. It relocates optionalDependencies injection in the publish job from before to after prepublish execution, introduces a new CHANGELOG.md file, and adds release guidance and platform-specific installation instructions to documentation files in both English and Chinese.

Changes

Cohort / File(s)	Summary
CI/Workflow .github/workflows/Release.yml	Moved optionalDependencies injection from pre-prepublish to post-prepublish step to prevent overwriting by prepublish process.
Documentation – Changelog CHANGELOG.md	New changelog file documenting versions 0.0.4 and 0.0.3 with fixed items, added features, and release notes following Keep a Changelog conventions.
Documentation – Release Guidance CONTRIBUTING.md, CONTRIBUTING-CN.md	Added "Release checklist (maintainers)" subsections instructing maintainers to update CHANGELOG.md and manage version links when cutting releases.
Documentation – Installation & Changelog README.md, README.zh-CN.md	Added platform-specific installation commands for macOS ARM/x64, Windows x64, and Linux x64; introduced Changelog sections directing users to CHANGELOG.md and GitHub Releases.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

• Feat/carbon dev #9: Modifies Release GitHub Actions workflow's handling of platform package names and optionalDependencies injection timing around prepublish steps.

Poem

🐰 A changelog born, to mark the way,
Release workflows dance and play,
Docs in two tongues, clear and bright,
Installation paths now set just right,
From pre to post, the timing's tight! ✨

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch doc/carbon-dev

---

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