Skip to content

Conversation

@tamlut-modnys
Copy link
Collaborator

  • Add Oracle Quotes, Surge, and Oracle Aggregator sections per chain
  • Add Advanced Feed Configuration under Solana and EVM data feeds
  • Move FAQ and Glossary to root level
  • Add chain READMEs, tutorials, and SAIL pages
  • Rename tooling-and-resources to tooling
  • Remove redundant directories (understanding-switchboard, product-documentation, oracle-quotes-the-new-standard, switchboard-surge)
  • Update SUMMARY.md with complete navigation structure

- Add Oracle Quotes, Surge, and Oracle Aggregator sections per chain
- Add Advanced Feed Configuration under Solana and EVM data feeds
- Move FAQ and Glossary to root level
- Add chain READMEs, tutorials, and SAIL pages
- Rename tooling-and-resources to tooling
- Remove redundant directories (understanding-switchboard, product-documentation, oracle-quotes-the-new-standard, switchboard-surge)
- Update SUMMARY.md with complete navigation structure

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@tamlut-modnys tamlut-modnys changed the title Restructure docs to match 1709f4a organization Test PR (don't merge) Dec 9, 2025
tamlut-modnys and others added 28 commits December 9, 2025 14:08
…d, Quick Start

- Update README.md with proper Introduction content
- Update why-switchboard.md with full content
- Update quick-start.md with proper content
- Fix SUMMARY.md to point to README.md for Introduction
- Remove redundant introduction.md

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
…path

- Fix "dedicatd" → "dedicated" typo in config docs
- Move switchboard-protocol content to how-it-works/switchboard-protocol/
- Delete unused directories: randomness/, switchboard/, switchboard-protocol/

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
The main data feeds content (README.md, Part 1-3 guides, costs, etc.) was
missing - only the designing-feeds/ subdirectory had been copied. This
restores all the missing content for both Solana and EVM chains.

Files restored:
- Solana: README, costs, eclipse, part-1/2/3 guides
- EVM: README, part-1/2/3 guides

Also fixed SUMMARY.md reference to integrating-into-frontends.md

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
New structure:
- Tutorials (with placeholder pages for Price Feeds, Prediction Market, Randomness)
- Surge (existing content)
- Custom Feeds (moved from Advanced Feed Configuration)

Removed from navigation:
- Data Feeds (old structure)
- Oracle Aggregator
- Oracle Quotes

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
Custom Feeds is now a top-level section alongside Docs by Chain,
How it Works, Tooling, etc.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
- Restore Aptos, Sui, Iota, Movement content from jack-v2
- Remove Starknet page and navigation entry

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
New EVM structure:
- Monad (integration guide from main)
- Hyperliquid (integration guide from main)
- Tutorials
  - Price Feeds (placeholder)
  - Randomness (moved from top-level EVM randomness)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
- Price Feeds now has two sub-pages:
  - Basic Price Feed
  - Advanced Price Feed

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
Complete guide for integrating Switchboard oracle price feeds including:
- Managed update system concepts
- Full Anchor program code with walkthrough
- TypeScript client implementation
- Step-by-step running instructions
- Integration guide for custom programs

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
Ultra-optimized oracle integration guide using Pinocchio framework:
- ~90% compute unit reduction (2,000 CU → 190 CU)
- Admin authorization pattern for trusted crankers
- Four modular instructions: init_state, init_oracle, crank, read
- QuoteVerifier for secure reads with staleness checks
- Security considerations for unchecked writes

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
Kalshi integration guide with feed ID verification security pattern:
- Oracle substitution attack prevention via feed ID verification
- SHA-256 hash of protobuf-encoded feed definitions
- QuoteVerifier for Ed25519 signature verification
- Kalshi RSA-PSS-SHA256 authentication flow
- Complete TypeScript client implementation
- Use cases: settlement, conditional payments, compliance
- Extension patterns for Polymarket and generic HTTP APIs

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
Verifiable randomness guide with commit-reveal pattern:
- Why naive randomness fails (predictable, manipulable)
- Commit-reveal security model explained
- Complete coin flip game implementation
- Three instructions: initialize, coin_flip, settle_flip
- Critical security: collateral on commit, slot freshness
- TypeScript client with retry logic
- Use cases: gaming, NFTs, lotteries, fair distribution

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Complete guide for integrating Switchboard price feeds on EVM
- Full SwitchboardPriceConsumer.sol contract example
- TypeScript client walkthrough with CrossbarClient
- Foundry deployment instructions for all networks
- DeFi examples: collateral ratio, liquidation checks
- Troubleshooting guide and available feeds

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Replace verbose Sui landing page with concise intro (523→27 lines)
- Add Project Structure and Available Scripts to Price Feeds tutorial
- Move deployments and feed hashes to both landing page and tutorial

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Add README.md overview
- Add Trusted Execution Environments (TEEs) documentation
- Add Oracle Queues documentation
- Add Node Architecture documentation

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Add EVM Surge tutorial for converting Surge updates to EVM format
- Merge Solana Accounts into Solana landing page
- Merge EVM Identifiers into EVM landing page as deployments table
- Merge Why Switchboard content into Introduction page
- Remove redundant standalone pages

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
tamlut-modnys and others added 10 commits December 18, 2025 16:37
- Restore Eclipse integration guide from preview branch
- Move Monad and Hyperliquid under EVM Tutorials

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Remove Tutorials subsections from Solana/SVM and EVM
- Rename Surge to Surge Price Feeds
- Rename Basic/Advanced Price Feed to include Tutorial suffix

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Move architecture diagram to overview page
- Convert surge.md to tutorial-only content
- Remove redundant overview content from tutorial page
- Update navigation title to "Surge Tutorial"

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Move tutorials out of subdirectories into chain root folders
- Rename surge-overview to surge for Solana
- Create EVM Surge overview page with tutorial
- Delete 60+ unused markdown files
- Rename SDKs page to "SDKs (Software Developer Kits)"
- Add CLAUDE.md with directory/nav sync guidelines

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Create price-feeds/, randomness/, prediction-market/, surge/ subdirectories
- Add README intro pages with overview content
- Move tutorials into subdirectories as *-tutorial.md files
- Update SUMMARY.md with new nested structure

Affected sections:
- EVM: Price Feeds, Randomness
- Solana: Randomness, Prediction Market
- Sui: Price Feeds, Surge Price Feeds

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Add comprehensive explanation of why randomness is hard on blockchains
- Explain oracle approach and trust problems
- Detail Switchboard's TEE-based solution
- Add end-to-end flow documentation
- Include sequence diagram

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
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.

2 participants