docs: sync pkc-js ecosystem docs with current code#4
Conversation
Updates four docs that had drifted from upstream code: corrects RPC method names in permissionless-public-rpc.md against pkc-js/src/rpc/src/index.ts, fixes the bso-resolver page (license, resolve() return shape, async PKC() factory), uses the actual bitsocial binary in cli.md, and adds the missing rpcUrls option to evm-contract-call.md.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughDocumentation updates across multiple files address API naming inconsistencies, license metadata, configuration additions, and integration pattern clarifications. Changes include configuration table enhancements, CLI command name standardization, resolution source corrections, method signature updates, and async API adoption patterns. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Possibly related issues
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Review rate limit: 0/1 reviews remaining, refill in 59 minutes and 22 seconds.Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/infrastructure/bso-resolver.md`:
- Line 12: Update the SPDX license identifier string used in the documentation
by replacing the current "GPL-3.0-or-later" token with the correct upstream
identifier "GPL-3.0"; locate the line that reads "**License**: GPL-3.0-or-later"
in the bso-resolver docs and change it to "**License**: GPL-3.0" so the README
matches the upstream repository's license.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 0d168bf0-638b-4977-9c86-4f4056b1c443
📒 Files selected for processing (4)
docs/anti-spam/evm-contract-call.mddocs/developer-tools/cli.mddocs/infrastructure/bso-resolver.mddocs/permissionless-public-rpc.md
|
Addressed the valid review finding in the latest commit: the BSO Resolver license now matches the upstream GitHub license endpoint ( |
Summary
Four docs had drifted from upstream code in
../pkc-js,../bso-resolver,../evm-contract-challenge, and@bitsocial/bitsocial-cli. This patches each one in place. The package-mirror pages are still hand-maintained — see follow-up issue for the automation question.docs/permissionless-public-rpc.md— RPC method names in the proposed permission bundle now match whatpkc-js/src/rpc/src/index.ts:210–233actually registers:fetchContent → fetchCid,resolveAuthorAddress → resolveAuthorName,communityListSubscribe → communitiesSubscribe. The other 13 method names already matched.docs/infrastructure/bso-resolver.md— licenseGPL-2.0-only → GPL-3.0-or-later(perbso-resolver/package.json),resolve()return shape clarified to aBsoResolveResultobject containingpublicKey, and the pkc-js integration snippet uses the real async factory shape (import PKC from "@pkcprotocol/pkc-js"; const pkc = await PKC({ nameResolvers })) instead of a fakenew Pkc({...})constructor.docs/developer-tools/cli.md— every shell example now invokes the actual binarybitsocial(the package is@bitsocial/bitsocial-clibut itsbinresolves tobitsocial, per the installed package'spackage.json). Repo and package-name references stay as-is.docs/anti-spam/evm-contract-call.md— adds the missingrpcUrlsoption to the configuration table; the actual challenge inevm-contract-challenge/src/evm-contract-challenge.ts:32defines six options and the docs only listed five.i18n copies under
docs/i18n/are not touched — the project regenerates those viascripts/translate-docs.pyas a separate step.Test plan
yarn lint(0 errors, pre-existing warnings only)yarn typecheck(exit 0)yarn formatran on the four files (oxfmt aligned the column widths in the evm-contract-call table)yarn docs:build:verifysucceeds, Pagefind index regenerated (35 pages)grep -nE "rpcWebsocketsRegister" pkc-js/src/rpc/src/index.tsbitsocial --helpagainst@bitsocial/bitsocial-cli/dist/cli/commands/scripts/translate-docs.pyto refreshdocs/i18n/**(separate step, intentionally out of scope)Summary by CodeRabbit
Documentation
API Updates
fetchCid,resolveAuthorName, andcommunitiesSubscribe.