Skip to content

README.md

Latest commit

 

History

History
23 lines (14 loc) · 1.36 KB

README.md

File metadata and controls

23 lines (14 loc) · 1.36 KB
Raw

Docs

Repo-wide documentation hub for @stainless-code/persist.

Canonical public site: https://stainless-code.com/persist (apps/docs). The root README.md is a short landing digest that links there.

This folder holds maintainer-facing reference and forward-looking work.

Reference

  • architecture.md — the three-seam model (backend × codec × source) and entry-point layout. Brief; the full API contract lives in the JSDoc of each module.
  • glossary.md — ubiquitous language for the persistence domain (backend, codec, source, envelope, hydration signal, generation guard, entry).
  • roadmap.md — forward-looking work only, not a mirror of src/.

Lifecycle folders

  • plans/ — in-flight work commits here; deleted + lifted when it ships.
  • audits/ — targeted audits; closed per the lifecycle in .agents/skills/docs-governance.
  • research/ — tool / approach evaluations; closed per the lifecycle.

Each folder carries a .gitkeep so it stays discoverable when empty.

Governance: this README follows the docs-governance skill — repo-wide Tier B surface: cross-cutting reference + lifecycle substrate, no feature-specific rules.