Reference Documentation
Technical reference materials for LLM4S development and maintenance.
Contributing
Start here if you want to contribute to the project.
- Contributing Guide - How to submit your first PR (read this first)
- Code Review Guidelines - Coding standards and patterns expected in PRs
- Testing Guide - How to write tests (contributor-focused)
- Code of Conduct - Community guidelines
Project Documentation
- Configuration Boundary - How configuration is isolated from core code
- Scalafix Rules - Linting rules and code quality
- Migration Guide - Upgrade between versions
- Test Coverage - Coverage tooling and thresholds
- Release Process - How releases are created
- Postgres Memory Store - PostgreSQL-backed agent memory persistence
- Troubleshooting / FAQ - Common errors and solutions
Roadmap & Planning
- Project Roadmap - Development roadmap, production readiness, and future plans (single source of truth)
- 1.0 Scope - Which packages are Frozen, Beta, or Experimental ahead of the 1.0 modularisation
- Design Documents - Detailed architecture docs
External Resources
- GitHub Repository: llm4s/llm4s
- Issue Tracker: GitHub Issues
- Pull Requests: GitHub PRs
Design Documents
Detailed design documents for agent framework phases:
| Document | Description |
|---|---|
| Agent Framework Roadmap | Comprehensive feature comparison and roadmap |
| Phase 1.1: Conversations | Functional conversation management |
| Phase 1.2: Guardrails | Input/output validation framework |
| Phase 1.3: Handoffs | Agent-to-agent delegation |
| Phase 1.4: Memory | Short/long-term memory |
| Phase 2.1: Streaming | Agent lifecycle events |
| Phase 2.2: Async Tools | Parallel tool execution |
| Phase 3.2: Built-in Tools | Standard tool library |
| Phase 4.1: Reasoning | Extended thinking support |
| Phase 4.3: Serialization | State persistence |
API Specifications
- Tool Calling API Design
- Workspace Protocol
- Langfuse Workflow Patterns
- Reliability Guide - Retry, circuit breaker, and deadline enforcement
Community Resources
- Discord: Join the community
- Starter Kit: llm4s.g8 - Project template
License
LLM4S is released under the MIT License.
Questions? Ask in Discord or open an issue.