Skip to content

socialdocs/socialdocs.org

Repository files navigation

SocialDocs

The comprehensive developer resource for ActivityPub and the Fediverse.

Website License: CC BY-SA 4.0 License: AGPL-3.0 PRs Welcome

About

SocialDocs provides documentation, guides, and tools for developers building with ActivityPub — the W3C standard powering the decentralized social web with 13+ million users across Mastodon, Lemmy, PeerTube, Pixelfed, and more.

What you'll find:

  • Getting Started — Beginner-friendly guides to federation concepts
  • Protocol Specs — ActivityPub, ActivityStreams, WebFinger, HTTP Signatures
  • Implementation Guides — Step-by-step tutorials for common patterns
  • API Reference — Object types, activity types, endpoints
  • Ecosystem Directory — Server software, libraries, tools
  • Developer Tools — Validators, inspectors, debugging tips

Contributing

We welcome contributions from the Fediverse community! See CONTRIBUTING.md for guidelines.

Quick contribution ideas:

  • Fix typos or clarify explanations
  • Add code examples in different languages
  • Document platform-specific quirks
  • Improve diagrams and visuals
  • Add new implementation guides

Local Development

# Install dependencies
npm install

# Start dev server
npm start

# Build for production
npm run build

The site runs at http://localhost:3000. Changes hot-reload automatically.

Project Structure

socialdocs.org/
├── docs/                  # Documentation content
│   ├── getting-started/   # Beginner guides
│   ├── specs/             # Protocol specifications
│   ├── guides/            # Implementation tutorials
│   ├── reference/         # API reference
│   ├── ecosystem/         # Software directory
│   ├── tools/             # Developer tools
│   └── community/         # Community resources
├── blog/                  # Blog posts
├── src/
│   ├── pages/             # Custom pages (homepage)
│   └── css/               # Global styles
├── static/                # Static assets
└── docusaurus.config.ts   # Site configuration

Tech Stack

Community

License

Documentation content is licensed under CC BY-SA 4.0.

Code examples are licensed under AGPL-3.0, consistent with the Fediverse ecosystem.


Built for the Fediverse community.

About

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •