docs: reconcile documentation with recent CaDecon review PRs (#153–163)#164
Merged
Conversation
Documentation-only pass. Audited the repo docs against the changes merged during the CaDecon pre-publication review and fixed stale/wrong/missing statements. No code changes. crates/solver/README.md: - Overview now describes the dual jsbindings/pybindings build and the full InDeCa pipeline (was "WASM-only, used by CaTune"). - Fixed the inner-loop convergence tolerance (1e-6 -> configurable 1e-4) and distinguished it from the outer shape-space convergence. - Rebuilt the module table (was 5 of 17 modules); documented ConvMode/banded AR(2), the EMA + rolling-quantile baseline, the InDeCa/seed WASM FFI, the PyO3 API, the non-finite input guard, and FitMode (8-tuple over PyO3). docs/ARCHITECTURE.md: - Corrected package/app counts (was "seven packages, two applications"); added the cadecon and admin apps and the @calab/ui/chart module; marked apps/cala + packages/cala-* as reserved (not-yet-built) scaffolding; noted CONVERGENCE_RANGES. Verified per-app deps against package.json. docs/CHANGELOG.md: - Added Unreleased entries for PRs #156-163 (with a note that #60-#155 were not recorded as they merged). apps/cadecon/PLAN.md: - Convergence description rewritten to shape-space (peak time + FWHM asymptote, patience/minIters, finalSelectionWindow) in both places it appeared. - Okabe-Ito palette (was D3 category10), removed KernelConvergence residual axis, ConvergencePanel tabs + AsymptoteTrends, KernelDisplay degeneracy warning, shared @calab/ui/chart primitives, raster viridis + colorbar removal, BiexpResult fit_mode, one-sample AR(2) source delay, FFI guard. Python docs (python/README.md, docs/guides/cadecon.md): - BiexpFitResult field list now includes fit_mode; documented that the deconvolution/fit entry points raise ValueError on non-finite input. (The Sphinx changelog include picks up the CHANGELOG edits automatically.) packages/ui + packages/core READMEs: - ui: description + a Chart utilities section (palette/colormap/axis helpers). - core: added CONVERGENCE_RANGES and the full wasm-adapter export list. docs/CONTRIBUTING.md, docs/NEW_APP.md, apps/catune/README.md: - Added the cadecon/admin workspaces and dev commands; noted @calab/ui/chart. Prettier-clean. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation-only pass. I audited the repo docs (four parallel read-only audits) against everything merged during the CaDecon pre-publication review and fixed stale/wrong/missing statements. No code changes.
crates/solver/README.md(most stale — published crate README)jsbindings/pybindingsbuild + the full InDeCa pipeline (was "WASM-only, used by CaTune").1e-6→ configurable1e-4; distinguished it from the outer shape-space convergence.ConvMode/banded AR(2), the EMA + rolling-quantile baseline, the InDeCa/seed WASM FFI, the PyO3 API, the non-finite input guard, andFitMode(8-tuple over PyO3).docs/ARCHITECTURE.mdcadeconandadminapps and the@calab/ui/chartmodule; markedapps/cala+packages/cala-*as reserved (not-yet-built) scaffolding; notedCONVERGENCE_RANGES. Per-app deps verified against eachpackage.json.docs/CHANGELOG.md[Unreleased]entries for PRs chore: gitignore python virtualenvs (.venv*/) #156–163 (with a note that refactor: make @calab/community package app-agnostic #60–feat(cadecon): asymptote dashboard — track the four convergence signals #155 went unrecorded as they merged — flagged below).apps/cadecon/PLAN.mdfinalSelectionWindow) in both places.ConvergencePaneltabs +AsymptoteTrends, KernelDisplay degeneracy warning, shared@calab/ui/chartprimitives, raster viridis + colorbar removal,BiexpResult.fit_mode, one-sample AR(2) source delay, FFI guard.Python docs (
python/README.md,docs/guides/cadecon.md)BiexpFitResultfield list now includesfit_mode; documented that the deconvolution/fit entry points raiseValueErroron non-finite input. (The Sphinx{include}picks up the CHANGELOG edits automatically.)packages/ui+packages/coreREADMEsCONVERGENCE_RANGESand the full wasm-adapter export list.docs/CONTRIBUTING.md,docs/NEW_APP.md,apps/catune/README.mdcadecon/adminworkspaces + dev commands; noted@calab/ui/chart.Heads-up (not addressed here)
CHANGELOG.mdhad gone unmaintained from ~PR refactor: make @calab/community package app-agnostic #60 to feat(cadecon): asymptote dashboard — track the four convergence signals #155 — I resumed coverage at chore: gitignore python virtualenvs (.venv*/) #156 rather than backfill ~95 PRs. Say the word if you want the gap reconstructed from git history.Prettier-clean (
format:checkpasses on all changed files).🤖 Generated with Claude Code