Skip to content

Replace MkDocs with Marimo and rename to scikit-play - #16

Merged
koaning merged 1 commit into
mainfrom
marimo-docs
Sep 29, 2025
Merged

Replace MkDocs with Marimo and rename to scikit-play#16
koaning merged 1 commit into
mainfrom
marimo-docs

Conversation

@koaning

@koaning koaning commented Sep 29, 2025

Copy link
Copy Markdown
Owner

Summary

  • Replaced MkDocs documentation with an interactive Marimo notebook
  • Renamed the project from scikit-playtime to scikit-play
  • Changed import name from playtime to skplay

Changes

Documentation Migration

  • Created docs.py - a single Marimo notebook containing all documentation
  • Added WASM export capability for browser-based interactive Python execution
  • Removed MkDocs configuration (mkdocs.yml) and old markdown files
  • Updated Makefile with new marimo commands for editing, serving, and building docs

Project Rename

  • Renamed package directory from playtime/ to skplay/
  • Updated all imports throughout the codebase:
    • Source code files
    • Test files
    • Documentation
    • README
  • Updated pyproject.toml with new project name and package references
  • Updated GitHub repository URLs in configuration

Test plan

  • Install the package: uv pip install -e ".[dev]"
  • Run the interactive docs: make docs-serve
  • Build WASM docs: make docs-build
  • Run tests: pytest
  • Verify imports work: from skplay import feats, onehot

🤖 Generated with Claude Code

@koaning
koaning merged commit aec29e9 into main Sep 29, 2025
3 of 4 checks passed
@koaning
koaning deleted the marimo-docs branch September 29, 2025 14:49
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.

1 participant