DOCS

short, scoped, self-contained

๐Ÿœ‚

GETTING STARTED

two minutes to running

๐Ÿœ

GUIDES

everyday workflows
  • INLINE EDITOR READ โ†’

    <script> install, data-ledric-ref / data-ledric-field attributes, refAttrs() helpers, auth, behaviour.

  • AGENT RECIPES READ โ†’

    Example prompts: project setup, drafting, schema evolution, bulk ops, refactoring, localization.

  • LOCALIZATION READ โ†’

    Per-type locales, localized:true fields, _locale sidecar, fallback chains, locale-specific slugs.

  • WHY LEDRIC READ โ†’

    Honest comparison vs Contentful, Sanity, Payload, Strapi, Directus โ€” and when ledric is the wrong choice.

  • FAQ READ โ†’

    The questions that come up most: production-readiness, SQLite limits, hosting, the agent angle, migration, backups.

  • ROADMAP READ โ†’

    What's stable, in progress, planned, and explicitly out of scope. No timelines โ€” just clear lines.

๐Ÿœƒ

REFERENCE

the surface, in full
  • SCHEMA READ โ†’

    Field types catalogue, defineType() examples, options, validation, schema evolution.

  • MCP TOOLS READ โ†’

    The 20-tool surface for agents โ€” reads, writes, schema, assets, tags. Same shape as POST /rpc.

  • REMOTE MCP READ โ†’

    Two modes: local (--http-mcp, share one daemon across local clients) and public (--public-mcp, OAuth provider for claude.ai custom connectors).

  • HTTP API READ โ†’

    REST routes for reads, multipart uploads, generic POST /rpc, image transforms, slug redirects, error codes.

  • SDKS READ โ†’

    @ledric/sdk (TypeScript) and Ledric\\LedricClient (PHP, Composer ledric/sdk) โ€” same wire format.

  • ASSETS READ โ†’

    id / ref_key split, db vs local backends, uploads, image transforms, in-place bytes replacement, transforms cache.

  • AUTH READ โ†’

    Reader and admin keys, key minting, header formats, closed-reads mode, rotation.

  • ARCHITECTURE READ โ†’

    What's running when ledric boots: the packages, the storage adapters, the asset pipeline, the inline editor, process lifecycle.

๐Ÿœ„

OPS

boring on purpose
  • DEPLOYMENT READ โ†’

    Production shape: CDN in front of /assets, reverse proxy + TLS, env-supplied keys, backups, Postgres / MySQL.