docs: update publishing guide

[tolgahan-arikan]

Summary

Update the publishing docs so the README points to the dedicated guide and the guide covers the full alpha release flow for both publishable packages.

Changes

• Replace the README's inline publishing instructions with a link to PUBLISHING.md.
• Document the lockstep SDK and wagmi connector version requirements.
• Add explicit SDK-first, connector-second dry-run, publish, and verification steps.
• Include current release checks for package versions, examples, and the wagmi connector.

Testing

• pnpm check:package-versions passes
• git diff --check passes
• pnpm exec vitest run passes (not run; documentation-only change)
• pnpm exec tsc --noEmit passes (not run; documentation-only change)
• pnpm test:types passes (not applicable; no public types changed)
• pnpm build succeeds (not run; documentation-only change)

Related

None.

[claude]

Claude finished @tolgahan-arikan's task —— View job

---

PR Review: docs: update publishing guide

Reviewing this documentation-focused PR against the specified criteria:

Review Checklist

• Read and analyze changed files (PUBLISHING.md and README.md)
• Check for SDK behavior changes
• Verify test coverage requirements
• Review public API changes and API.md impact
• Check for .js extension patterns in imports
• Scan for committed secrets or credentials
• Verify TypeScript soundness
• Assess documentation quality and accuracy

Review Summary

This is a documentation-only change that moves publishing instructions from the README to a dedicated PUBLISHING.md guide. The changes are well-structured and improve the organization of the repository's documentation.

✅ Positive Findings

1. Clear Documentation Structure: Moving publishing instructions to a dedicated file improves README readability and provides a focused reference for maintainers.

2. Comprehensive Publishing Flow: The new PUBLISHING.md includes all necessary steps with proper ordering (SDK first, then wagmi connector) and verification commands.

3. Enhanced Instructions: Added missing steps like pnpm check:package-versions, build commands for all examples, and explicit dry-run steps for both packages.

4. No Security Issues: No secrets, credentials, or sensitive information committed.

5. Proper Command Structure: All bash commands are properly formatted and include necessary flags (--frozen-lockfile, --tag alpha, etc.).

✅ Technical Compliance

Since this is documentation-only:

• SDK Behavior Changes: ✅ None - no code changes
• Test Coverage: ✅ N/A - documentation only
• Public API Changes: ✅ None - no API.md updates needed
• Import Extensions: ✅ N/A - no source code changes
• Secrets: ✅ None committed
• TypeScript: ✅ No type changes

📝 Minor Suggestions

1. Line 42: Consider adding pnpm build:wagmi-example to the release checks for consistency with other examples.

   • Status: ✅ Already included in the updated version

2. Verification Commands: The addition of pnpm view commands after each publish step is excellent for verification.

3. Version Variable: Using VERSION=$(node -p "require('./package.json').version") is a good practice for consistency.

✅ Documentation Quality

• Clarity: Instructions are clear and well-organized with proper headings
• Completeness: Covers the full alpha release workflow for both packages
• Accuracy: Commands align with the project structure and tooling
• Maintainability: Centralized publishing docs make maintenance easier

Final Assessment

APPROVED ✅ - This is a high-quality documentation improvement with no code changes. The restructured publishing guide provides clear, comprehensive instructions that enhance the developer experience for maintainers handling releases.