Docs To-dos

[derrekcoleman]

Completed

• Update discord link to BOB Revert docs to only refer to Conduit's testnet #209
• Revert docs to only refer to Conduit's testnet #209
• Update docs to reflect Hybrid L2 positioning #214
• Create the Privileged Roles page #215
• Add mainnet info, add “hybrid” to metadata #220
• Remove mentions of Flask from Snap page #223
• Add guide for bridging from Ethereum #224
• Add bridge overview, resize images #230 , Adjust wording for onramp overview #231
• added bob fusion guide #229
• Add Tools to docs #232
• Add CTA links for builders to connect with BD #243
• Add node providers, BlastAPI RPC, and other tools #253
  • DIA copy
  • BlastAPI RPC nodes
  • Arcana Auth
  • Add instructions on how to start a full node
• Update Notion to point to SwaggerUI for Spice APIs
• User guide: onramp from bitcoin (similar to what Dom did for Fusion campaign) Overview
  • Add a way for interested LPs to contact us (modify builder form)
• Add BOB Gateway guide and simplify onboarding page #264
• Fix node guide re: Conduit (this repo no longer exists, so point here instead)
• HelloBitcoin: deploy relay script
• Docs Revamp Part 1/2: (Re)moving Pages #382
• Add "Research" page to docs #393
• Update node info with upcoming Holocene upgrade #428
• Broken links in the docs #423
• docs: update intro, add gateway explainer, misc updates #425
• Add FusionLock audits to Security page (Discord) docs: add audits for Gateway, USDC, FusionLock #434
• Add USDC, ERC20 audits to Security page (Discord) docs: add audits for Gateway, USDC, FusionLock #434
• Add Tellor contracts to Oracles docs: add to Tools section #435
• Add LayerZero to Tools docs: add to Tools section #435
• Add WETH to Bridged Token Addresses docs: add to Tools section #435
• docs: bring back the MetaMask Snap page #440

High

• Draft BitVM2 Bridge explainer (similar to this one, blog brief, other references on Discord)
• docs: rework AA page without live demo #443
• chore: add Sepolia flags for holocene upgrade #444
• Update BOB Stack page
• docs: add hardware wallet support #424 Ledger -> Ledger (on BOB) guide (Discord)
• User guide: onramp from exchange
• Add Gateway contract docgen back (details in 1.)
• Create page for "How to create a new strategy/interface for Gateway" (blocked by Nakul's refactor)
• Add Chainlink CCIP to Cross-chain (Base example)

Medium

• Add AI-based search to our docs (Docusaurus has first-class support for Algolia) - Applied for DocSearch program on 25 June
• Add page clarifying T&Cs, Liability (reference, request)
• Customize 404 text (how-to, Discord)
• Fix HelloBitcoin: replace missing dependencies
• Add docs on how transaction fees are calculated (adapt from https://docs.optimism.io/builders/app-developers/transactions/fees)
• Add status page to docs (example location on right side of header)
• Update rollup page to use new visuals and point to the Optimine paper
• Explain reads (relay, oracle) and writes (bridging) in the context of BOB
• Add link checking action to CI/CD
• Create Founder Resources page (draft here)

Low

• Add e2e tests to docs (tutorial)
• Interact directly with Bitcoin relay in the docs page
• Add tooltips for all instances of a glossary of terms (plugin)
• Update bob-collective org-level README (Example)

Never

• Connect wallet in docs to use faucet
• Bring SwaggerUI natively "into" docs pages using this plug-in
• Add Testnet, Mainnet to wallet buttons (example)
• Interactive examples in docs