Skip to content

docs: fix stale README and CI docs - #528

Draft
roxdanila wants to merge 2 commits into
devfrom
docs/SDK-1-fix-stale-readme-and-ci-docs
Draft

roxdanila wants to merge 2 commits into
devfrom
docs/SDK-1-fix-stale-readme-and-ci-docs

Conversation

@roxdanila

@roxdanila roxdanila commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

The README and .github/ci-cd.md name npm, a CommonJS-only build and a release-next.yml workflow; the repo uses pnpm, ships CommonJS and ES module builds, and releases through release.yml with prep-next.yml and prep-latest.yml.

Changes

  • README usage: names both builds, CommonJS dist/index.js and ES module dist/index.mjs.
  • README development: npm ci is now pnpm install --frozen-lockfile, npm build is now pnpm build.
  • ci-cd.md diagram and headings: release-next.yml is replaced by release.yml with prep-next.yml, and release.yml gains prep-latest.yml.
  • ci-cd.md workflow sections: one line each on what the prep workflow does before release.yml publishes.
  • ci-cd.md trigger: synchronized is now synchronize, the event name GitHub sends.

Verification

  • Scope: only stale lines change, +10/-8.
  • Workflows: release.yml, prep-next.yml, prep-latest.yml and pull-request.yml exist on dev. release-next.yml does not.
  • Mermaid: the diagram in ci-cd.md parses.
  • CI: CodeRabbit and Cloudflare Pages pass.
  • Note: package.json has no exports field, so Node never loads dist/index.mjs, even for import. Out of scope here.

https://claude.ai/code/session_01FjVHkVpGB3gEtSYKx6SgCw

- README: describe the CommonJS and ES module builds
- README: use pnpm for install and build
- ci-cd.md: replace release-next.yml with release.yml, prep-next.yml and prep-latest.yml

Claude-Session: https://claude.ai/code/session_01YQqkmq95Nszo7TL9gcwKTJ
@coderabbitai

coderabbitai Bot commented Oct 16, 2026

Copy link
Copy Markdown

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Deploying sdk with  Cloudflare Pages  Cloudflare Pages

Latest commit: dc858eb
Status: ✅  Deploy successful!
Preview URL: https://6ad72b81.sdk-9yp.pages.dev
Branch Preview URL: https://docs-sdk-1-fix-stale-readme.sdk-9yp.pages.dev

View logs

Restore the original prose and change only the stale references.

Claude-Session: https://claude.ai/code/session_01YQqkmq95Nszo7TL9gcwKTJ
@roxdanila
roxdanila requested a review from rackstar October 16, 2026 21:52

This branch has not been deployed

No deployments
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