jollywhoppers.com / socialsync
A Minecraft Fabric mod that connects the game with ATProtocol ⛏️
8
fork

Configure Feed

Select the types of activity you want to include in your feed.

socialsync / docs / README.md
at main 9.3 kB view raw view code
Ewan Croft refactor: unify project branding to "Social Sync" and bump version to 0.5.0
e1c72ad6

Social Sync Documentation Index#

Welcome to the Social Sync documentation. This index helps you find the information you need.

Getting Started#

Documentation Structure#

For Users#

Document Purpose Audience
README.md Project overview & features Everyone
APPVIEW_QUICKSTART.md Deploy AppView service Server Operators
TEST_GUIDE.md Run and write tests Developers

For Developers#

Document Purpose Audience
API_REFERENCE.md Complete API documentation API Developers
ARCHITECTURE.md System design & internals Core Developers
TEST_GUIDE.md Testing framework & practices QA Engineers

For System Administrators#

Document Purpose Audience
ARCHITECTURE.md Deployment options DevOps/Admins
APPVIEW_QUICKSTART.md AppView deployment DevOps/Admins
ARCHITECTURE.md Monitoring & operations Operators

For Community#

Document Purpose Audience
APPVIEW.md How AppView works Community Members
APPVIEW.md Bluesky integration Integrators

Authentication & Security#

Commands#

Data Syncing#

AppView#

Testing#

Deployment#

Troubleshooting#

API Reference by Component#

Session Management#

Record Management#

Security#

Storage#

AppView#

Code Examples#

Quick Examples#

Advanced Topics#

Glossary#

Term Definition
AT Protocol Decentralized social protocol powering Bluesky
DID Decentralized Identifier (user identity on AT Protocol)
Handle Human-readable username (e.g., alice.bsky.social)
PDS Personal Data Server (stores user's data)
AppView Service that displays/queries published records
Lexicon Schema definitions for records
XRPC AT Protocol's RPC mechanism
TID Timestamp-based ID for records
rkey Record key (TID or "self" for literal records)

File Structure#

docs/
├── README.md                    # This index
├── API_REFERENCE.md            # Complete API documentation (500+ lines)
├── ARCHITECTURE.md             # System design & deployment (600+ lines)
├── APPVIEW.md                  # AppView guide (600+ lines)
├── APPVIEW_QUICKSTART.md       # AppView setup (400+ lines)
├── APPVIEW_INDEX.md            # AppView documentation index
├── APPVIEW_COMPLETION.md       # Feature completion summary
├── TEST_GUIDE.md               # Testing documentation (300+ lines)
└── examples/
    ├── AppViewExample.kt       # 10 working examples
    ├── RecordCreationExample.kt
    └── RecordManagerExamples.kt

src/
├── main/
│   ├── kotlin/com/jollywhoppers/
│   │   ├── socialsync.kt              # Main initializer
│   │   └── atproto/
│   │       ├── server/
│   │       │   ├── AppViewService.kt      # AppView indexing
│   │       │   ├── AppViewHttpServer.kt   # AppView HTTP API
│   │       │   ├── RecordManager.kt       # Record CRUD
│   │       │   ├── At*.kt                 # Core services
│   │       │   └── *SyncService.kt        # Sync services
│   │       ├── security/
│   │       │   ├── SecurityUtils.kt
│   │       │   ├── RateLimiter.kt
│   │       │   └── SecurityAuditor.kt
│   │       └── client/
│   │           └── *
│   └── resources/
│       ├── lexicons/           # Lexicon schemas
│       └── assets/
└── test/
    └── kotlin/com/jollywhoppers/
        ├── CoreTests.kt        # Main test suite (20+ tests)
        └── ...

Documentation Statistics#

Metric Value
Total Documentation 3,500+ lines
API Reference 500+ lines
Architecture Guide 600+ lines
Test Guide 300+ lines
Code Examples 10 complete scenarios
Test Coverage 20+ tests

Contributing to Documentation#

If you're adding a new feature:

  1. Add API Documentation - Document new methods in API_REFERENCE.md
  2. Add Examples - Create example code in docs/examples/
  3. Add Tests - Add test cases in src/test/
  4. Update Architecture - Update ARCHITECTURE.md if it changes system design
  5. Add to Index - Link from this index

Maintenance Schedule#

Task Frequency
Update examples Monthly
Review API docs Quarterly
Update architecture As needed
Audit test coverage Monthly

Support#

Questions?

  • Check the index above
  • Search in relevant documentation
  • Check code examples
  • Review troubleshooting sections

Found an issue?

  • Report in Issues
  • Include documentation link
  • Suggest improvements

Want to contribute?

  • Follow contribution guidelines
  • Submit pull request with docs
  • Link to this index from new docs

Additional Resources#

Last Updated: April 2026 Version: 0.5.0 Status: Complete ✅

Quick Navigation#