Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ These four packages release together under one aligned version.
Packages named `@pretable-internal/*` are repo-local implementation details.
Do not build application code against them.

See the [roadmap](./ROADMAP.md) for current priorities and the financial-grade
product direction.

## Install

```bash
Expand Down Expand Up @@ -125,6 +128,7 @@ streaming hypotheses remain directional rather than fully satisfied.
## Repository Layout

```text
ROADMAP.md Current product priorities and sequencing
apps/bench Benchmark lab and browser test target
apps/website Documentation and marketing site
packages/core Public framework-agnostic grid primitives
Expand Down
93 changes: 93 additions & 0 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# Pretable roadmap

Last reviewed: 2026-08-10

Pretable is a batteries-included React data grid built to be the fastest and
best grid for demanding, financial-grade applications. The roadmap uses two
reference workloads: live portfolio-management systems and collaborative
financial planning.

## Governing principles

- Performance and correctness are product features: every major capability gets
an explicit complexity/memory budget, deterministic workload, and committed
evidence.
- Pretable ships working grid behavior and UI, not interfaces alone.
- One canonical derived model governs rendering, focus, selection, editing,
clipboard, accessibility, and virtualization.
- The grid remains finance-capable but domain-agnostic; applications own
valuation, formulas, permissions, storage endpoints, and retention policy.
- Public state and protocols are versioned and migration-aware.

## Current baseline

The aligned public-package baseline is `0.0.14`. The released grid already
includes local sorting and typed filtering, selection, keyboard navigation,
copy and validated bulk paste, typed asynchronous editing, column virtualization
and layout, configurable row grouping and aggregation with an overflow-safe
group panel, number-column alignment with tabular number/date figures,
variable-height rows, and batched streaming transactions. Package changelogs
and generated API reports are the source of truth for shipped behavior.

See the current [core changelog](packages/core/CHANGELOG.md),
[React changelog](packages/react/CHANGELOG.md),
[core API report](packages/core/core.api.md),
[React API report](packages/react/react.api.md), and
[committed comparative benchmark evidence](status/milestones/2026-05-12-comparator-aware-evaluators.hypotheses.json).

## Now — harden and measure

- Close remaining public API/documentation gaps and make stable row identity
consistent across entry points.
- Finish grouping adoption with committed benchmark evidence.
- Add deterministic PMS and financial-planning benchmark profiles without
weakening existing 60 Hz, zero-gap, and interaction-continuity gates.

## Next — describe and manipulate financial views

1. Add a financial field schema, nested column bands, field chooser, formatting
descriptors, and view-management surface.
2. Ship saved-view persistence: a versioned portable view document, migrations,
schema reconciliation, browser-local storage, remote store adapter, and
shared/personal view layers.
3. Add a typed command foundation with atomic edit/paste batches, inverses, and
bounded local undo/redo. Saved views precede command history.

## Later — remote scale, analytics, and collaboration

1. Add a remote/live row model with bounded caching, typed query plans,
cancellation, partial/stale/error state, and ordered resynchronization.
2. Add revisioned mutations with command IDs, base revisions, optimistic and
pessimistic execution, conflicts, rollback, retries, and resync.
3. Develop parallel application tracks:
- PMS analytics: incremental grouping/aggregation, totals, pivot,
drill-through, context actions, and export.
- Financial planning: range editing, fill, row creation/reordering, formula
and provenance surfaces, and time/scenario comparison columns.
4. Add provider-backed durable audit/version history, history UI,
revert-as-new-command, redaction, retention hooks, and collaborative updates.
5. Converge both tracks with shared/personal configuration, capability-aware UI,
tree data, localization, and accessibility hardening.

## Not planned

- A hosted Pretable backend or authentication system.
- Finance-domain valuation, formula, scenario, or permission policy.
- A chart, page-layout, or financial-application platform.
- Persistence of complete runtime grid snapshots.

## Persistence and history sequence

Saved views → command foundation and local undo/redo → revisioned mutations →
durable audit/version history.

See the approved [persistence and history design](docs/superpowers/specs/2026-08-09-persistence-and-history-design.md)
and its [documentation implementation plan](docs/superpowers/plans/2026-08-09-persistence-and-history-documentation.md).

## How roadmap items ship

An item moves into implementation only after an approved focused design and
implementation plan. It is complete only when public API reports, consumer
documentation, correctness tests, and relevant benchmark evidence agree with the
released behavior. The roadmap tracks outcomes; changelogs track shipped work,
and dated plans remain historical execution recipes.
59 changes: 59 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Pretable documentation

This directory preserves product decisions, execution recipes, research, and
handoffs. It is an archive with explicit authority rules, not the current
roadmap.

## Authority

1. Package changelogs and generated API reports describe shipped behavior.
2. [ROADMAP.md](../ROADMAP.md) describes current prioritization.
3. docs/superpowers/specs/ contains approved design and decision records.
4. docs/superpowers/plans/ contains execution recipes, not live status.
5. status/milestones/ contains committed performance evidence.
6. docs/research/ and handoffs are historical unless a current document links
to them explicitly.

When documents disagree, use the highest applicable source above. Public
consumer documentation must describe released behavior and should not advertise
speculative roadmap APIs.

## Lifecycle

New design specs use `docs/superpowers/specs/YYYY-MM-DD-<topic>-design.md`.
Implementation plans use `docs/superpowers/plans/YYYY-MM-DD-<topic>.md`.

Every new spec should include:

- Date
- Status: draft, approved, planned, in-progress, shipped, or superseded
- Supersedes / Superseded by when applicable
- implementation plan, PR/commit, and released version when those exist

Status meanings:

- draft: under discussion
- approved: design accepted; no implementation plan is implied
- planned: an implementation plan exists
- in-progress: implementation is active
- shipped: released behavior exists; changelogs/API reports remain authoritative
- superseded: retained for history and linked to its replacement

Unchecked boxes in an old plan do not prove work remains. Confirm shipped state
from changelogs, API reports, and implementation history.

## Repository map

- superpowers/specs/: dated designs and decision records
- superpowers/plans/: dated implementation recipes
- research/: diagnostics, closeouts, and historical memory
- handoffs/ and superpowers/handoffs/: point-in-time transfer notes
- ../status/milestones/: committed benchmark evidence

## Maintenance

- Keep ROADMAP.md short and outcome-oriented.
- Mark superseded documents; do not delete decision history.
- Link corrections to the evidence they replace.
- Update public documentation, API reports, and changelogs with shipped APIs.
- Review roadmap claims against committed evidence before publishing them.
4 changes: 4 additions & 0 deletions docs/research/repo-memory.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Repo Memory

> **Status: Historical through 2026-05-15.** This chronological record is
> preserved as project history and is not a current backlog. See the canonical
> [ROADMAP.md](../../ROADMAP.md) for current priorities.

## 2026-04-12

### Prototype direction
Expand Down
Loading