Repository navigation
docs: migrate compressionKIT to Astro and retire Zensical - #69
Merged
Merged
Conversation
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The quickstart currently fails, notebook figures lack meaningful alternative text, and version-only changes bypass preview CI.
Review effort: Balanced
Findings: 3
Open (3)
What changed in this PR
Adds a preview-only Astro/Starlight documentation site while retaining the existing Zensical deployment.
Changes:
- Adds sectioned navigation, migrated guides, API reference generation, notebook rendering, and evidence tables.
- Adds migration, link, layout, content, and notebook validation tooling.
- Adds a non-deploying GitHub Actions preview workflow.
| File | Description |
|---|---|
compressionkit/runtime/codec.py |
Corrects dependency documentation. |
compressionkit/runtime/__init__.py |
Clarifies runtime import dependencies. |
astro-site/tsconfig.json |
Enables strict Astro TypeScript configuration. |
astro-site/src/styles/site.css |
Adds site, responsive, and notebook styling. |
astro-site/src/section-matcher.ts |
Implements section-scoped route matching. |
astro-site/src/redirects.json |
Defines authored redirects. |
astro-site/src/navigation.mjs |
Defines site navigation and sidebars. |
astro-site/src/content/docs/validation-scorecard.md |
Documents validation metrics. |
astro-site/src/content/docs/use-cases.mdx |
Adds use cases and payload examples. |
astro-site/src/content/docs/signals/ppg.md |
Documents PPG support. |
astro-site/src/content/docs/signals/ppg-workflow.md |
Describes the PPG workflow. |
astro-site/src/content/docs/signals/index.md |
Adds signal overview. |
astro-site/src/content/docs/signals/ecg.md |
Documents ECG support. |
astro-site/src/content/docs/models/index.md |
Adds the model catalog. |
astro-site/src/content/docs/methods/spiht.md |
Documents SPIHT. |
astro-site/src/content/docs/methods/rvq.md |
Documents RVQ. |
astro-site/src/content/docs/methods/index.md |
Compares codec methods. |
astro-site/src/content/docs/methods/hybrid.md |
Documents hybrid compression. |
astro-site/src/content/docs/methods/cr_vs_fidelity_ppg.mdx |
Renders PPG fidelity tables. |
astro-site/src/content/docs/methods/cr_vs_fidelity_ecg.mdx |
Renders ECG fidelity tables. |
astro-site/src/content/docs/index.mdx |
Adds the Astro homepage. |
astro-site/src/content/docs/huggingface.md |
Documents bundle loading. |
astro-site/src/content/docs/getting-started.md |
Adds the codec quickstart. |
astro-site/src/content/docs/experiments/ppg-spiht-8x.mdx |
Adds PPG SPIHT 8× facts. |
astro-site/src/content/docs/experiments/ppg-spiht-4x.mdx |
Adds PPG SPIHT 4× facts. |
astro-site/src/content/docs/experiments/ppg-spiht-32x.mdx |
Adds PPG SPIHT 32× facts. |
astro-site/src/content/docs/experiments/ppg-spiht-2x.mdx |
Adds PPG SPIHT 2× facts. |
astro-site/src/content/docs/experiments/ppg-spiht-16x.mdx |
Adds PPG SPIHT 16× facts. |
astro-site/src/content/docs/experiments/ppg-rvq-8x.mdx |
Adds PPG RVQ 8× facts. |
astro-site/src/content/docs/experiments/ppg-rvq-8x-prior.mdx |
Adds PPG RVQ 8× prior facts. |
astro-site/src/content/docs/experiments/ppg-rvq-4x.mdx |
Adds PPG RVQ 4× facts. |
astro-site/src/content/docs/experiments/ppg-rvq-4x-prior.mdx |
Adds PPG RVQ 4× prior facts. |
astro-site/src/content/docs/experiments/ppg-rvq-32x.mdx |
Adds PPG RVQ 32× facts. |
astro-site/src/content/docs/experiments/ppg-rvq-2x.mdx |
Adds PPG RVQ 2× facts. |
astro-site/src/content/docs/experiments/ppg-rvq-16x.mdx |
Adds PPG RVQ 16× facts. |
astro-site/src/content/docs/experiments/ppg-hybrid-8x.mdx |
Adds PPG hybrid 8× facts. |
astro-site/src/content/docs/experiments/ppg-hybrid-4x.mdx |
Adds PPG hybrid 4× facts. |
astro-site/src/content/docs/experiments/ppg-hybrid-32x.mdx |
Adds PPG hybrid 32× facts. |
astro-site/src/content/docs/experiments/ppg-hybrid-2x.mdx |
Adds PPG hybrid 2× facts. |
astro-site/src/content/docs/experiments/ppg-hybrid-16x.mdx |
Adds PPG hybrid 16× facts. |
astro-site/src/content/docs/experiments/index.md |
Adds the experiment catalog. |
astro-site/src/content/docs/experiments/ecg-spiht-8x.mdx |
Adds ECG SPIHT 8× facts. |
astro-site/src/content/docs/experiments/ecg-spiht-64x.mdx |
Adds ECG SPIHT 64× facts. |
astro-site/src/content/docs/experiments/ecg-spiht-4x.mdx |
Adds ECG SPIHT 4× facts. |
astro-site/src/content/docs/experiments/ecg-spiht-32x.mdx |
Adds ECG SPIHT 32× facts. |
astro-site/src/content/docs/experiments/ecg-spiht-2x.mdx |
Adds ECG SPIHT 2× facts. |
astro-site/src/content/docs/experiments/ecg-spiht-16x.mdx |
Adds ECG SPIHT 16× facts. |
astro-site/src/content/docs/experiments/ecg-rvq-8x.mdx |
Adds ECG RVQ 8× facts. |
astro-site/src/content/docs/experiments/ecg-rvq-8x-prior.mdx |
Adds ECG RVQ 8× prior facts. |
astro-site/src/content/docs/experiments/ecg-rvq-64x.mdx |
Adds ECG RVQ 64× facts. |
astro-site/src/content/docs/experiments/ecg-rvq-4x.mdx |
Adds ECG RVQ 4× facts. |
astro-site/src/content/docs/experiments/ecg-rvq-4x-prior.mdx |
Adds ECG RVQ 4× prior facts. |
astro-site/src/content/docs/experiments/ecg-rvq-32x.mdx |
Adds ECG RVQ 32× facts. |
astro-site/src/content/docs/experiments/ecg-rvq-2x.mdx |
Adds ECG RVQ 2× facts. |
astro-site/src/content/docs/experiments/ecg-rvq-16x.mdx |
Adds ECG RVQ 16× facts. |
astro-site/src/content/docs/experiments/ecg-hybrid-8x.mdx |
Adds ECG hybrid 8× facts. |
astro-site/src/content/docs/experiments/ecg-hybrid-64x.mdx |
Adds ECG hybrid 64× facts. |
astro-site/src/content/docs/experiments/ecg-hybrid-4x.mdx |
Adds ECG hybrid 4× facts. |
astro-site/src/content/docs/experiments/ecg-hybrid-32x.mdx |
Adds ECG hybrid 32× facts. |
astro-site/src/content/docs/experiments/ecg-hybrid-2x.mdx |
Adds ECG hybrid 2× facts. |
astro-site/src/content/docs/experiments/ecg-hybrid-16x.mdx |
Adds ECG hybrid 16× facts. |
astro-site/src/content/docs/experiment-architecture.md |
Documents experiment architecture. |
astro-site/src/content/docs/examples.md |
Catalogs notebook examples. |
astro-site/src/content/docs/demo/ppg-codec.md |
Links the maintained browser demo. |
astro-site/src/content/docs/customer-evidence.mdx |
Renders recorded evidence. |
astro-site/src/content/docs/api/preprocessing.md |
Adds preprocessing API links. |
astro-site/src/content/docs/api/models.md |
Adds model API links. |
astro-site/src/content/docs/api/export.md |
Adds export API links. |
astro-site/src/content/docs/api/evaluation.md |
Adds evaluation API links. |
astro-site/src/content/docs/api/datasets.md |
Adds dataset API links. |
astro-site/src/content/docs/api/configs.md |
Adds configuration API links. |
astro-site/src/content/docs/adding-a-codec-family.md |
Documents codec-family extension. |
astro-site/src/content.config.ts |
Configures the documentation collection. |
astro-site/src/components/HomeHero.astro |
Implements the custom homepage hero. |
astro-site/src/components/FidelityTable.astro |
Renders fidelity snapshots. |
astro-site/src/components/ExperimentFacts.astro |
Renders registry-derived facts. |
astro-site/src/components/EvidenceTable.astro |
Renders evidence snapshots. |
astro-site/scripts/refresh-fidelity.py |
Refreshes fidelity data. |
astro-site/scripts/refresh-evidence.py |
Refreshes evidence data. |
astro-site/scripts/publish-reference.mjs |
Publishes API Markdown and redirects. |
astro-site/scripts/public-api.json |
Allow-lists public API modules. |
astro-site/scripts/link-audit.test.mjs |
Tests local link auditing. |
astro-site/scripts/fidelity-data.test.mjs |
Tests fidelity validation and refresh. |
astro-site/scripts/fidelity-data.mjs |
Validates fidelity snapshots. |
astro-site/scripts/export-experiments.py |
Exports experiment registry facts. |
astro-site/scripts/evidence-data.test.mjs |
Tests evidence validation and refresh. |
astro-site/scripts/evidence-data.mjs |
Validates evidence snapshots. |
astro-site/scripts/docstring-markdown.test.mjs |
Tests docstring conversion. |
astro-site/scripts/docstring-markdown.mjs |
Converts literal blocks for MDX. |
astro-site/scripts/check-migration.mjs |
Audits migration coverage and anchors. |
astro-site/scripts/check-links.mjs |
Audits local links and assets. |
astro-site/scripts/check-external-links.mjs |
Audits external URLs. |
astro-site/scripts/build-notebooks.py |
Generates notebook guide pages. |
astro-site/scripts/audit-layout.mjs |
Browser-checks rendered routes. |
astro-site/README.md |
Documents site development and validation. |
astro-site/public/assets/compressionkit-icon.svg |
Adds the product icon. |
astro-site/package.json |
Defines site dependencies and commands. |
astro-site/notebook-execution-audit.json |
Records notebook execution results. |
astro-site/CONTENT-OWNERSHIP.md |
Defines content ownership and refresh rules. |
astro-site/AUDIT.md |
Records migration validation. |
astro-site/astro.config.mjs |
Configures Astro, Starlight, and Helia UI. |
astro-site/.nvmrc |
Selects Node 24. |
.gitignore |
Ignores generated Astro outputs. |
.github/workflows/docs-preview.yml |
Adds preview validation CI. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
apage224
changed the title
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
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.
Migrate compressionKIT documentation to Astro/Starlight with section-scoped navigation, reviewed public guides, generated Python API reference and three notebook guides. Registry facts and scorecard tables render independently of authored prose.
Replace the Pages build with validated Astro output. Remove the Zensical configuration, duplicate documentation tree, obsolete experiment-page generator and Python docs dependencies. Preserve three planning/research notes outside the public site. Retain the scorecard helpers used by Astro, with standalone reports written under results/reports, and direct plot generation to Astro assets.
Closes #68.
Validation:
Deployment: PR workflows validate without deploying. After merge, the Pages workflow validates and deploys astro-site/dist at /compressionkit/. The published site has not changed yet. Rollback instructions are in astro-site/README.md.
Limitations: three PhysioNet URLs remain DNS-unverified. No GPU, training, hardware, population-scale evaluation or all-model-tier validation. Measurement tables remain preserved snapshots.