Skip to main content

Hello Developer Portal

· 4 min read
François-Xavier THOORENS
François-Xavier THOORENS
CEO Vaultys
Jérôme Delaire
Jérôme Delaire
Lead Dev

We're thrilled to announce the launch of our completely redesigned documentation portal for the Vaultys Peer SDK! After months of listening to your feedback and working closely with our community, we've built a documentation experience that makes it easier than ever to create powerful peer-to-peer applications.

🚀 What's New?​

📚 Comprehensive Documentation​

Our new documentation portal isn't just a reference manual – it's a complete learning platform designed to take you from P2P beginner to expert. Here's what you'll find:

  • Getting Started Guides: Step-by-step tutorials that get you up and running in minutes
  • API Reference: Complete TypeScript-first API documentation with real-world examples
  • Architecture Deep Dives: Understand how Vaultys works under the hood
  • Migration Guides: Seamlessly upgrade from older versions
  • Best Practices: Learn from our experience building P2P applications at scale

🎮 Interactive Playground​

One of the most exciting features is our new Interactive Playground. No more copying and pasting code snippets – you can now:

  • Try P2P connections in real-time directly in your browser
  • Experiment with different configurations and see instant results
  • Test collaborative features like shared documents and real-time sync
  • Debug WebRTC connections with built-in diagnostic tools

Try the Playground Now →

🔥 Live Code Examples​

Every code example in our documentation is now:

  • Runnable: Click "Run" to see the code in action
  • Editable: Modify examples and see how changes affect the output
  • Forkable: Save your experiments and share them with others
  • TypeScript-ready: Full type hints and IntelliSense support

💡 Key Features Highlighted​

🔋 Batteries Included​

Powered by VaultysId, our leading open-source Decentralized Identity System, the SDK comes with everything you need:

import { setupVaultysPeerSDK } from '@vaultys/peer-sdk';

// That's it! You're ready to go
const sdk = await setupVaultysPeerSDK();
const peer = await sdk.connect('peer-id');

⚡ Lazy Loading at Scale​

Managing thousands of peers? No problem! Our SDK features:

  • Zero connection overhead until you actually need to communicate
  • Automatic connection management with smart pooling
  • On-demand resource allocation for optimal performance

🏗️ Bring Your Own Infrastructure (BYOI)​

We believe in giving you control:

  • Use our default signaling servers for quick prototyping
  • Deploy your own signaling infrastructure for production
  • Implement custom DID providers (coming soon!)
  • Build private networks with full data sovereignty

📖 Documentation Sections​

Getting Started​

Perfect for newcomers to P2P development. Learn the basics of:

  • WebRTC fundamentals
  • Setting up your first peer connection
  • Handling real-time messages
  • Building a complete chat application

API Reference​

Comprehensive documentation of every class, method, and interface:

  • PeerService - Core service for managing connections
  • VaultysPeer - Individual peer connection management
  • VaultysId - Identity and cryptographic operations
  • Event handling and error management

Guides & Tutorials​

Step-by-step guides for common use cases:

  • Building a video chat application
  • Creating collaborative documents
  • Implementing file sharing
  • Setting up secure group communications
  • Deploying to production

Advanced Topics​

For when you're ready to dive deeper:

  • Custom signaling server implementation
  • Post-quantum cryptography with ML-KEM
  • Performance optimization techniques
  • Security best practices
  • Scaling strategies

🎯 Developer Experience First​

We've obsessed over every detail to make your development experience delightful:

TypeScript Native​

Full TypeScript support with comprehensive type definitions:

interface PeerConfig {
  vaultysId?: VaultysId;
  storageProvider?: StorageProvider;
  relay?: PeerJSConfig;
  debug?: boolean;
}

Our new search powered by AI understands what you're looking for:

  • Search by concept, not just keywords
  • Get relevant results even with typos
  • Find related topics and examples

Dark Mode​

Because we know you're coding at 2 AM:

  • Automatic theme detection
  • Syntax highlighting optimized for both themes
  • Reduced eye strain for those long coding sessions

🌟 Community Contributions​

This documentation wouldn't be possible without our amazing community. Special thanks to:

  • Contributors who submitted PRs improving our docs
  • Early adopters who provided invaluable feedback
  • Discord community members who helped identify gaps
  • GitHub issue reporters who helped us prioritize

🤝 Get Involved​

The best documentation is built by the community, for the community:

Contribute​

  • Report issues or suggest improvements on GitHub
  • Submit PRs to fix typos or add examples
  • Share your projects built with Vaultys

Connect​

🙏 Thank You​

Building great documentation is a journey, not a destination. We're committed to continuously improving based on your feedback. Every question you ask, every issue you report, and every suggestion you make helps us make the docs better for everyone.

We can't wait to see what you'll build with Vaultys Peer SDK!

Happy coding! 🚀

Ready to dive in? Start with our Quick Start Guide →

Have questions? Join our Discord →