Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .claude/skills/prep-release/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,19 @@ Prepare a new wigglystuff release. Follow these steps:
- Look at the git diff against `main` to determine what changed

4. **Update all documentation locations** for any new widgets:
- `mkdocs/reference/<widget-name>.md` — create a reference doc following the pattern in existing reference pages (use `::: wigglystuff.module.ClassName` mkdocstrings directive + a synced traitlets table)
- `mkdocs.yml` — add the widget to the `nav` Reference section
- `mkdocs/index.md` — add to the appropriate gallery section (main gallery or 3rd party gallery)
- `docs/reference/<widget-name>.md` — create a reference doc following the pattern in existing reference pages (use `::: wigglystuff.module.ClassName` mkdocstrings directive + a synced traitlets table)
- `zensical.toml` — add the widget to the `nav` Reference section
- `docs/index.md` — add to the appropriate gallery section (main gallery or 3rd party gallery)
- `readme.md` — add to the appropriate gallery table (main gallery or 3rd party table)
- `mkdocs/llms.txt` — add a one-line entry in the appropriate section
- `docs/llms.txt` — add a one-line entry in the appropriate section
- `CLAUDE.md` — add a row to the quick reference table
- `wigglystuff/__init__.py` — verify the widget is imported and listed in `__all__`

5. **For 3rd party widgets** (those requiring non-core dependencies like neo4j, torch, wandb):
- Place them in the "3rd party widgets" section of the galleries (not the main gallery)
- Use a molab link for the demo instead of a local example page
- Use `MOLAB_LINK_HERE` as a placeholder if the molab link is not yet available and tell the user they need to fill it in
- Screenshot path should be `mkdocs/assets/gallery/<widgetname>.png` — tell the user if one is missing
- Screenshot path should be `docs/assets/gallery/<widgetname>.png` — tell the user if one is missing

6. **Check dependencies**: Read `pyproject.toml` and verify that no 3rd party widget dependency (neo4j, torch, wandb, etc.) has been added to core `[project] dependencies`. These must only appear under `[project.optional-dependencies]` as extras. Core dependencies should only include packages needed by all widgets (anywidget, numpy, pillow, python-dotenv). If a 3rd party dep has leaked into core dependencies, remove it.

Expand Down
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ Untitled.ipynb
**/__marimo__/**
!**/__marimo__/session/
!**/__marimo__/session/**
mkdocs/examples/*
!mkdocs/examples/.demo-hashes.json
docs/examples/*
!docs/examples/.demo-hashes.json

wandb/**
6 changes: 3 additions & 3 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ syncs back to Python.
overrides that respond to `.dark`, `.dark-theme`, or `[data-theme="dark"]`
ancestors so notebook-level theme toggles work instantly.
- When adding a new widget, remember to update the docs gallery
(`mkdocs/index.md`), the README gallery (`readme.md`), the LLM context
file (`mkdocs/llms.txt`), and the changelog (`CHANGELOG.md`). Add a
screenshot to `mkdocs/assets/gallery/` and reference it from the gallery
(`docs/index.md`), the README gallery (`readme.md`), the LLM context
file (`docs/llms.txt`), and the changelog (`CHANGELOG.md`). Add a
screenshot to `docs/assets/gallery/` and reference it from the gallery
locations to keep them in sync.
- New or changed features that haven't been released yet go under the
`## [Unreleased]` section at the top of `CHANGELOG.md`. That section gets
Expand Down
74 changes: 37 additions & 37 deletions README.md

Large diffs are not rendered by default.

File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion scripts/post_zensical.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
from pathlib import Path

ROOT = Path(__file__).resolve().parents[1]
DOCS_DIR = ROOT / "mkdocs"
DOCS_DIR = ROOT / "docs"
SITE_DIR = ROOT / "site"


Expand Down
8 changes: 4 additions & 4 deletions zensical.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ site_description = "Creative AnyWidgets for notebooks"
site_url = "https://koaning.github.io/wigglystuff/"
repo_url = "https://github.com/koaning/wigglystuff"
repo_name = "koaning/wigglystuff"
docs_dir = "mkdocs"
docs_dir = "docs"
site_dir = "site"

nav = [
Expand Down Expand Up @@ -57,7 +57,7 @@ extra_css = ["assets/stylesheets/extra.css"]
# Theme
# ----------------------------------------------------------------------------
[project.theme]
custom_dir = "mkdocs/overrides"
custom_dir = "docs/overrides"
logo = "assets/logo.png"
favicon = "assets/logo.png"
language = "en"
Expand All @@ -79,8 +79,8 @@ features = [
repo = "fontawesome/brands/github"

[project.theme.font]
text = "Geist"
code = "Geist Mono"
text = "IBM Plex Sans"
code = "JetBrains Mono"

[[project.theme.palette]]
scheme = "default"
Expand Down
Loading