libLogit is a cross-language logging SDK. Developers should be able to import
or install the SDK, create a LOGIT, set an output directory or file path plus
a log level, and immediately send logs to console, local storage, remote-path
destinations, and eventually richer transports.
These docs are written as the public GitHub-facing documentation set for people who want to use libLogit, evaluate the v1 Alpha, or help build the v1 Beta.
If you only read three things, read these in order:
That path shows the whole product idea quickly: create a LOGIT, point it at a
directory or file, set a level, and call it.
This docs set has two jobs:
So the docs are intentionally split between product-facing pages and execution pages. The product-facing pages explain what the SDK is and how to use it. The execution pages explain what still has to be built, hardened, tested, and released.
| Need | Document |
|---|---|
| Understand the Beta direction | v1 Beta overview |
| See the Beta roadmap in product terms | v1 Beta roadmap |
| Understand how readiness percentages are scored | v1 Beta readiness rubric |
| See the portable field contract in one page | LOGIT contract matrix |
| See how current schemas line up with that contract | Config schema audit |
| Understand construction, emit, flush, close, and unsupported-field behavior | LOGIT lifecycle and compatibility rules |
| See what each binding actually supports today | Binding compatibility matrix |
| See how setup/config errors should surface | Error taxonomy and unsupported-field policy |
| See how Beta will freeze the schema story | Beta schema version strategy |
Try the portable LOGIT pattern |
Getting started |
| Start a minimal project in your language | Starter project guides |
| Configure a logger in a project | Developer instructions |
| Query retained logs with SQL or the viewer | SQL inspection and viewer workflow |
| Know how to install or evaluate a binding today | Install and package status |
| Understand the SDK structure | SDK architecture |
| Compare language readiness | Language matrix |
| See current gaps without marketing gloss | Known limitations |
| Implement a new language binding | Binding playbook |
| Jump straight to runnable samples | Examples index |
| Check the current callable surface | Alpha API reference |
| Configure named loggers | Configuration guide |
| Move from early configs | Migration guide |
| Track remaining work | Burndown |
v1 Alpha is the functional showcase release. It proves the object model across the MVP language set: Python, C++, C, C#, Java, JavaScript, Go, and Kotlin.
The current Alpha line includes direct LOGIT objects, structure-fed setup,
config-loaded named loggers, console output, file output, remote-path-as-file
output, level filtering, text and JSON-lines formatting, shared fixtures, and a
Python reference implementation with SQLite storage, bounded retention, and a
minimal viewer.
Alpha is very close to release-candidate readiness, but the final release gate still depends on hosted CI observation and final promotion evidence. The authoritative readiness snapshot lives in the burndown.
Beta is the contract-hardening release. The goal is not to claim that every
language ships on day one. The goal is to make the SDK language-agnostic by
freezing the portable LOGIT contract, defining conformance fixtures, hardening
packages, and giving future bindings a repeatable implementation path.
The stable words in this repo are:
| Term | Use it for |
|---|---|
| SDK | The installable libLogit product for a language/ecosystem. |
| API | The methods and fields a user calls, such as LOGIT(), .localPath, .level, and .log(). |
| Binding | A language-specific implementation of the SDK contract. |
| LOGIT | A user-owned logging device with path, level, sink, formatter, retention, and runtime state. |
docs/beta/ contains the public Beta-facing plan, roadmap, readiness rubric,
contract matrix, schema audit, lifecycle/compatibility rules, binding
compatibility matrix, error taxonomy, schema version strategy,
getting-started flow, install status, architecture notes, language matrix,
limitations, and binding rules.docs/api/ describes the current Alpha API surface and the Beta contract
direction.docs/bindings/ contains binding-specific notes and the future-language
proposal template.docs/project/ contains planning documents, intake criteria, and taxonomy.docs/releases/ contains Alpha release-candidate evidence and promotion
checklists plus the draft Beta release packet.docs/research/ contains market and feature research that informs the SDK.