You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Replace the MkDocs site with Astro/Starlight and HELIA styling while preserving authored routes, notebook examples and Python API coverage. The landing page introduces the toolkit, scoped navigation reduces nesting, and conversion fixes restore tables, callouts, tabs and configuration examples.
Approach
Generate 55 authored pages, a saved-output notebook page and 110 public Python API module pages; retain historical API redirects and search/discovery exports.
Exclude private implementation modules, maintainer proposals and draft license terms from pages, navigation, search and machine-readable exports; retain their repository sources.
Render the more complete repository notebook with three saved figures. Preserve both original notebook downloads, without executing training.
Correct documented factory examples, feature fields and historical experiment context. Python source changes are docstring repairs only.
Build/test on PRs and deploy Pages from main or manual dispatch, independently of package releases.
Validation
Astro check: zero errors/warnings. Production build, internal links across 314 HTML files, source-based feature checks, four converter tests and ten Playwright tests pass. Desktop/mobile/light/dark layouts inspected; all authored pages received a rendered review.
Boundaries and follow-up
No notebook training, dataset acquisition, hardware deployment or full package installation rerun. Saved results remain historical. Code/model refresh and Hugging Face publication are separate follow-up work. Site deployment will be verified after merge.
Select the task matching the sleep-detection configuration
docs/quickstart.md:144
The configuration displayed immediately below is a sleep-detection configuration (FS-W-A-5, detect_labels, and WAKE/SLEEP classes), but this snippet selects the staging task. As written, the quickstart labels a detection run as staging; select detect or provide a matching staging configuration.
Align the workflow task with the detection configuration
docs/usage/python.md:75
The included example configuration uses detection features and detect_labels, while this workflow selects stage. A reader following the complete example therefore runs detection settings under the staging task name; use the detection key or show a staging configuration instead.
Use the correct model name field
sleepkit/models/__init__.py:64
helia-edge==0.4.1 defines this field as name, not model_name. Because the parameter model ignores unknown fields, the example silently leaves the model name at its default instead of applying "tcn".
Fix backend guide imports for InferenceBackend and BackendFactory
docs/modes/demo.md:83
The backend guide cannot run as written: sleepkit does not export InferenceBackend or BackendFactory at the top level (sleepkit/__init__.py:11-20); both live under sleepkit.backends. The class definition and the later registration/lookup snippets therefore raise AttributeError. Use sk.backends.InferenceBackend and sk.backends.BackendFactory, or import both from sleepkit.backends, throughout this section.
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
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.
Problem and result
Replace the MkDocs site with Astro/Starlight and HELIA styling while preserving authored routes, notebook examples and Python API coverage. The landing page introduces the toolkit, scoped navigation reduces nesting, and conversion fixes restore tables, callouts, tabs and configuration examples.
Approach
Validation
Astro check: zero errors/warnings. Production build, internal links across 314 HTML files, source-based feature checks, four converter tests and ten Playwright tests pass. Desktop/mobile/light/dark layouts inspected; all authored pages received a rendered review.
Boundaries and follow-up
No notebook training, dataset acquisition, hardware deployment or full package installation rerun. Saved results remain historical. Code/model refresh and Hugging Face publication are separate follow-up work. Site deployment will be verified after merge.
Closes #43