Four pages under docs/ are hand-maintained mirrors of upstream package READMEs but have no sync mechanism, so they silently drift from the source repos. Examples found in #4 included a wrong license, a fake constructor (new Pkc({...}) instead of the real async factory), .bso-only when .eth is also supported, a missing config option, and stale RPC method names.
Pages affected:
docs/infrastructure/bso-resolver.md ← bitsocialnet/bso-resolverdocs/anti-spam/captcha-canvas-challenge.md ← bitsocialnet/captcha-canvas-challengedocs/anti-spam/evm-contract-call.md ← bitsocialnet/evm-contract-challengedocs/anti-spam/voucher-challenge.md ← bitsocialnet/voucher-challenge
Each repo already publishes a README.md that is the natural source of truth. Without a sync step (build-time fetch, scheduled job, or pre-commit hook), every release of these packages forces a manual catch-up pass on these docs, and discrepancies are easy to miss until someone notices. Worth deciding whether to (a) set up an automated sync, (b) treat the docs as authored-once landing pages and link out to the upstream README, or (c) keep both and accept the drift.
PR #4 is the most recent in-place catch-up.
Four pages under
docs/are hand-maintained mirrors of upstream package READMEs but have no sync mechanism, so they silently drift from the source repos. Examples found in #4 included a wrong license, a fake constructor (new Pkc({...})instead of the real async factory),.bso-only when.ethis also supported, a missing config option, and stale RPC method names.Pages affected:
docs/infrastructure/bso-resolver.md←bitsocialnet/bso-resolverdocs/anti-spam/captcha-canvas-challenge.md←bitsocialnet/captcha-canvas-challengedocs/anti-spam/evm-contract-call.md←bitsocialnet/evm-contract-challengedocs/anti-spam/voucher-challenge.md←bitsocialnet/voucher-challengeEach repo already publishes a
README.mdthat is the natural source of truth. Without a sync step (build-time fetch, scheduled job, or pre-commit hook), every release of these packages forces a manual catch-up pass on these docs, and discrepancies are easy to miss until someone notices. Worth deciding whether to (a) set up an automated sync, (b) treat the docs as authored-once landing pages and link out to the upstream README, or (c) keep both and accept the drift.PR #4 is the most recent in-place catch-up.