Skip to content

docs: realign the docs with the recent contract changes - #121

Merged
peter-gy merged 5 commits into
mainfrom
pgy/docs-coherence
Oct 25, 2026
Merged

peter-gy merged 5 commits into
mainfrom
pgy/docs-coherence

Conversation

@peter-gy

Copy link
Copy Markdown
Collaborator

The last dozen PRs each updated the pages they touched, so the docs drifted between pages rather than within them. This pass reads docs/, development_docs/, the READMEs, the skill, and AGENTS.md together against the current code.

  • Compatibility. docs/reference/compatibility.md now lists the oldest reader that accepts each kind of new export content (control domain, unavailable outputs, read-only snapshots, indexes over 100,000 values), and a "Changes after 0.2.2" table with the caller action for the prepared query renames, the ExportOutput union, and [tool.marimo-export] imports.
  • Stale contracts. The docs now say custom exporters skip the cell cache, producer identity covers the notebook's imports, the market dashboard and vite-vanilla capture steps set the access token they need, exit code 6 covers an oversized index, and the skill uses the current query functions and read_only caveats.
  • Ownership. AGENTS.md and the architecture notes route the owners the recent ports introduced: exporters/_prepare.py, exporters/_identity.py, exporters/_anywidget_assets.py, _marimo/file_urls.py, _marimo/ui_functions.py, _environment.py, _index_budget.py, and _observations/runs.py and source.py.
  • marimo upstream proposals. Each candidate cites its private marimo seam at 0.25.2 and at current main, and what marimo-export would delete. New candidates cover a config-selected cell-cache loader, a per-graph cache key input, AppKernelRunner.close(), a runtime filename for marimo edit, UI element introspection, and the host protocol as a speculative transport. The integration notes record that marimo main still reports 0.25.2 while three pinned digests differ, so the digest check is the real release gate.

Copilot AI balanced review requested due to automatic review settings October 25, 2026 17:28

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

…main

Each candidate now cites the private marimo seam at 0.25.2 and at main, with what marimo-export would delete. New candidates cover a config-selected cell-cache loader, a per-graph cache key input, AppKernelRunner.close(), a runtime-filename option for marimo edit, UI element introspection, and the host protocol as a speculative transport. The integration notes record that marimo main still declares 0.25.2 while three pinned source digests differ, so the digest gate identifies the supported release.
The dependency rule and change routing name exporters/_prepare.py, exporters/_identity.py, exporters/_anywidget_assets.py, _marimo/file_urls.py, _marimo/ui_functions.py, _environment.py, and _observations/runs.py and source.py where they now own behavior.
@peter-gy
peter-gy merged commit 7a14235 into main Oct 25, 2026
22 checks passed
@peter-gy
peter-gy deleted the pgy/docs-coherence branch October 25, 2026 18:47
@github-actions

Copy link
Copy Markdown

marimo-export 0.2.3.dev15 from this pull request is available as a preview build:

uv pip install "marimo-export @ https://github.com/marimo-team/marimo-export/releases/download/preview/marimo_export-0.2.3.dev15-py3-none-any.whl"
pnpm add "https://github.com/marimo-team/marimo-export/releases/download/preview/marimo-team-marimo-export-0.2.3-dev.15.tgz"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants