Skip to content

[codex] Document compatibility matrix#68

Merged
samlaycock merged 2 commits into
mainfrom
codex/document-compatibility-matrix
May 21, 2026
Merged

[codex] Document compatibility matrix#68
samlaycock merged 2 commits into
mainfrom
codex/document-compatibility-matrix

Conversation

@samlaycock

Copy link
Copy Markdown
Owner

Summary

Documents the package compatibility and runtime support expectations requested by Issue #57.

  • Adds a README compatibility table covering Bun installation, the effect peer dependency range, TypeScript support, ESM/CJS declarations, the fluent-effect/effect passthrough export, and Bun-based runtime validation assumptions.
  • Adds the same focused support matrix to docs/package-exports.md, where entrypoint and import guarantees are already documented.
  • Adds a patch changeset for the documentation update.

Impact

Consumers no longer need to infer package manager, peer dependency, module format, or entrypoint support from package.json, tsconfig.json, and package smoke tests.

Closes #57.

Validation

  • bun fmt
  • bun lint:fix
  • bun test
  • bun typecheck

Add a concise compatibility section to the README and package exports documentation covering Bun usage, the Effect peer dependency range, TypeScript support, package entrypoints, and runtime validation assumptions.

Include a patch changeset for the documentation update.
@samlaycock samlaycock marked this pull request as ready for review May 20, 2026 18:08
@greptile-apps

greptile-apps Bot commented May 20, 2026

Copy link
Copy Markdown

Greptile Summary

This PR adds a compatibility matrix to README.md and docs/package-exports.md covering package manager, effect peer dependency range (^3.21.0), TypeScript 5 support, ESM/CJS/declaration module formats, the fluent-effect/effect passthrough export, and Bun-based runtime assumptions. All documented values match what is declared in package.json.

  • The README gains a new Compatibility section between the installation instructions and the Quick Start.
  • docs/package-exports.md gains an equivalent Compatibility Matrix section with slightly more precise per-row wording suited to its entrypoint-focused audience.
  • A patch changeset accompanies the update per the project's conventions.

Confidence Score: 5/5

Pure documentation change with no code modifications; all stated values are consistent with package.json.

The change adds two compatibility tables and a changeset file. Every factual claim in the tables (peer dependency range ^3.21.0, TypeScript 5, ESM/CJS exports, Bun-based tooling) is verified by package.json. There are no code paths touched.

No files require special attention.

Important Files Changed

Filename Overview
.changeset/soft-ravens-dance.md Patch changeset for the compatibility documentation additions.
README.md Adds a Compatibility section with a six-row table covering package manager, Effect peer dependency, TypeScript, module formats, native Effect export, and runtime assumptions; all values match package.json.
docs/package-exports.md Adds a matching Compatibility Matrix section; row wording is slightly more precise than the README equivalent (e.g. 'Root export' instead of 'Module formats') and consistent with the surrounding doc context.

Reviews (2): Last reviewed commit: "docs: clarify README package manager sup..." | Re-trigger Greptile

Comment thread README.md Outdated
Align the README compatibility matrix with the package exports documentation so Bun is scoped to repository development tooling rather than implied as a consumer runtime requirement.
@samlaycock samlaycock merged commit d0fa014 into main May 21, 2026
2 checks passed
@samlaycock samlaycock deleted the codex/document-compatibility-matrix branch May 21, 2026 06:48
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.

P3: Document package compatibility and runtime support matrix

1 participant