Skip to content

docs: refresh stale versions, changelog, roadmap, known-limitations (audit 2/4) - #108

Closed
rz1989s wants to merge 1 commit into
fix/docs-sdk-0.9-code-examplesfrom
fix/docs-staleness
Closed

docs: refresh stale versions, changelog, roadmap, known-limitations (audit 2/4)#108
rz1989s wants to merge 1 commit into
fix/docs-sdk-0.9-code-examplesfrom
fix/docs-staleness

Conversation

@rz1989s

@rz1989s rz1989s commented Jun 6, 2026

Copy link
Copy Markdown
Member

Summary

Part 2 of 4 of the June 2026 docs audit (#96) — version/status staleness. Brings the docs current with SDK 0.9.0 and the M17-complete / M18-in-progress reality.

⚠️ Stacked on #107 (PR1). GitHub will retarget this PR's base to main once #107 merges — please review/merge #107 first.

What's refreshed (15 files)

  • changelog — added 0.7.0 (M15: hardware wallets, WalletConnect, surveillance scoring, monitoring), 0.8.0 (M16–M17: Solana + NEAR same-chain privacy, Solana mainnet-beta, C-SPL, Tor/SOCKS5, Winternitz vault), 0.9.0 (M18: EVM privacy scanning + Solidity contracts + 105+ Foundry tests); updated the Version History table. Dates taken from the real git tags.
  • roadmap — M16/M17 ✅ (mainnet live), M18 🔄 in progress; test count 6,850 → 7,624+; contributing refocused on M18/M19.
  • known-limitations — corrected the false "proofs are mock / not cryptographically sound / testnet-only / Noir planned" claims, plus "no hardware wallet support" and "single proof provider" — all shipped (NoirProofProvider/BrowserNoirProvider UltraHonk, M15 hardware wallets, on-chain HonkVerifier on Sepolia + Arbitrum Sepolia). This page was actively underselling the protocol as not production-ready.
  • security audit docs (audit-preparation / audit-scope / audit-checklist, internal-review) — @noble dep versions (ciphers 2.0.1 → 2.2.0, etc.), test counts (1,293 → 6,716 / 7,624+), audit timeline (Q1 2025 → Solana Audit Subsidy V, Feb 2026), noir.ts LOC. Genuinely-dated snapshots get a "point-in-time" caveat rather than a rewrite.
  • api-migration — version framing v0.1.x → 0.9.0 (the deprecation policy is date-based, not version-based — both old facts were wrong).
  • deployment — docs-sip / blog / cdn / sip-website now on Vercel (June 2026); "Last Updated" refreshed.
  • misc — getting-started Node 18 → 20; faq handle @rz1989sol → @sipprotocol; architecture NoirProofProvider Planned → Available + same-chain note; whitepaper sub-10ms → sub-30ms (self-consistency) + Railgun "EVM-only"; comparison Zcash Groth16 → "Groth16 (Sapling) / Halo 2 (Orchard)".

Verification

  • astro build green — 1277 pages.

Series

PR1 (#107) code examples + #1073 · PR2 (this) staleness · PR3 security-crypto + design banners + constraint counts · PR4 sipher SENTINEL → closes #96.

Refs #96

June 2026 docs audit, part 2/4 (#96). Brings versioned/status content up to
date with SDK 0.9.0 and the M17-complete / M18-in-progress reality.

- changelog: add 0.7.0 (M15 hardware wallets/WalletConnect/surveillance),
  0.8.0 (M16-M17 Solana+NEAR same-chain, mainnet-beta, C-SPL), 0.9.0 (M18 EVM
  privacy + Solidity contracts); update Version History table (dates from tags)
- roadmap: M16/M17 done (mainnet live), M18 in progress; tests 6,850 -> 7,624+;
  refocus contributing on M18/M19
- known-limitations: correct false "proofs are mock / testnet-only / Noir
  planned" + "no hardware wallet" + "single proof provider" -- all shipped
  (NoirProofProvider/BrowserNoirProvider, M15 hardware wallets, on-chain
  HonkVerifier on Sepolia/Arbitrum Sepolia)
- security audit-prep/scope/checklist/internal-review: @noble dep versions
  (ciphers 2.0.1 -> 2.2.0 etc.), test counts, audit timeline (Q1 2025 ->
  Solana Audit Subsidy V Feb 2026), noir.ts LOC; dated snapshots get caveats
- api-migration: version framing v0.1.x -> 0.9.0 (deprecation is date-based)
- deployment: docs/blog/cdn/sip-website now on Vercel; date refresh
- getting-started Node 18 -> 20; faq @rz1989sol -> @sipprotocol; architecture
  NoirProofProvider Planned -> Available; whitepaper sub-10ms -> sub-30ms +
  Railgun EVM-only; comparison Zcash Groth16 -> Halo2 (Orchard)

astro build green (1277 pages). Stacked on the PR1 code-examples branch.
@vercel

vercel Bot commented Jun 6, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
sip-docs Ready Ready Preview, Comment Jun 6, 2026 10:09am

@rz1989s

rz1989s commented Jun 6, 2026

Copy link
Copy Markdown
Member Author

Superseded by #111 — this PR was auto-closed when its base branch (fix/docs-sdk-0.9-code-examples) was deleted on #107's merge. Identical content re-targeted at main in #111.

@rz1989s
rz1989s deleted the fix/docs-staleness branch June 6, 2026 11:26
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