[Cross-cutting] Create API documentation and usage guides

[konard]

Summary

Create comprehensive API documentation and usage guides for Links Queue.

Background

Good documentation is essential for adoption. Following code-architecture-principles:

• Small Public Documentation: Focus on frequently-used, stable APIs

Requirements

API Reference

• Document all public interfaces and types
• Include code examples for each method
• Specify return types and error conditions
• Auto-generate from JSDoc/rustdoc where possible

Usage Guides

1. Getting Started

   • Installation
   • Quick start example
   • Configuration basics

2. Core Concepts

   • What are links?
   • Link data model
   • Queue semantics
   • Delivery guarantees

3. Operating Modes

   • single-memory
   • single-stored
   • multi-memory
   • multi-stored
   • When to use each

4. Storage Backends

   • Memory backend
   • link-cli backend
   • Creating custom backends

5. Server Mode

   • Starting the server
   • Client connection
   • Protocol reference

6. Clustering

   • Setting up a cluster
   • Node discovery
   • Partitioning
   • Replication

7. Best Practices

   • Error handling
   • Performance tuning
   • Monitoring

Documentation Structure

docs/
├── api/
│   ├── js/
│   │   └── README.md  # Generated from JSDoc
│   └── rust/
│       └── README.md  # Link to docs.rs
├── guides/
│   ├── getting-started.md
│   ├── core-concepts.md
│   ├── operating-modes.md
│   ├── storage-backends.md
│   ├── server-mode.md
│   ├── clustering.md
│   └── best-practices.md
└── README.md  # Documentation index

Deliverables

1. Getting Started guide
2. Core Concepts guide
3. Operating Modes guide
4. Storage Backends guide
5. Server Mode guide (after Phase 5)
6. Clustering guide (after Phase 6)
7. Best Practices guide
8. API reference generation setup

Dependencies

• Guides can be written as features are developed
• API reference requires feature implementation

Can Be Worked On Independently

Documentation can be written in parallel with feature development. Placeholder guides can be created early and filled in as features are completed.

References

• VISION.md - Project vision
• ARCHITECTURE.md - Technical details
• COMPARISON.md - Feature comparison