Skip to content

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

Merged
rz1989s merged 1 commit into
mainfrom
fix/docs-staleness
Jun 6, 2026
Merged

docs: refresh stale versions, changelog, roadmap, known-limitations (audit 2/4)#111
rz1989s merged 1 commit into
mainfrom
fix/docs-staleness

Conversation

@rz1989s

@rz1989s rz1989s commented Jun 6, 2026

Copy link
Copy Markdown
Member

Summary

Re-opens the PR2 staleness changes — originally #108, which GitHub auto-closed when its base branch was deleted as part of merging #107 (stacked-PR + delete-branch gotcha). #107 is now merged to main; this re-targets the same fix/docs-staleness branch at main. Identical content to #108.

Part 2 of 4 of the June 2026 docs audit (#96) — version/status staleness.

What's refreshed (15 files)

  • changelog — added 0.7.0 (M15), 0.8.0 (M16–M17 Solana+NEAR same-chain, mainnet-beta), 0.9.0 (M18 EVM); Version History table. Dates from real git tags.
  • roadmap — M16/M17 ✅ (mainnet live), M18 🔄; tests 6,850 → 7,624+.
  • known-limitations — corrected the false "proofs are mock / testnet-only / Noir planned" + "no hardware wallet" + "single proof provider" claims (all shipped).
  • security audit docs@noble dep versions, test counts, audit timeline (→ Solana Audit Subsidy V, Feb 2026); dated snapshots get caveats.
  • misc — api-migration version framing; deployment Vercel topology; getting-started Node 18→20; faq @rz1989sol → @sipprotocol; architecture NoirProofProvider → Available; whitepaper sub-30ms + Railgun "EVM-only"; comparison Zcash Halo 2 (Orchard).

Full description + rationale: #108. astro build green (1277 pages).

Series

PR1 (#107, merged) · PR2 (this, was #108) · PR3 (#109) · PR4 (#110) → 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.
@rz1989s
rz1989s merged commit fa04435 into main Jun 6, 2026
3 checks passed
@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.

Monthly Docs Audit - June 2026

1 participant