Skip to content

Commit bf3f7ea

Browse files
committed
test
1 parent 06a2816 commit bf3f7ea

File tree

3 files changed

+32
-6
lines changed

3 files changed

+32
-6
lines changed

.licenserc.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ header:
5555
- ".husky/_/pre-rebase"
5656
- ".husky/_/prepare-commit-msg"
5757
- ".husky/pre-commit"
58-
- "lint-errors.txt"
59-
- "npm-build.txt"
58+
- "**/*.disabled"
6059

6160
comment: on-failure

CLAUDE.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ npm run storybook
4949
## Development Setup
5050

5151
1. **Requirements**:
52-
- Node.js >= 18.0.0
52+
- Node.js >= 20.0.0
5353
- npm (not yarn - the project uses npm workspaces)
5454
2. **Ports**:
5555
- Jupyter server: 8686
@@ -100,7 +100,7 @@ Components showcased in `storybook/`
100100
- Single quotes, trailing commas (all)
101101
- 80 character line width
102102
- LF line endings
103-
- Ignores `attic/` folder
103+
- Ignores `attic/` folder and `*.mdx` files (to prevent MDX comment corruption)
104104

105105
### Pre-commit Hooks
106106

@@ -113,9 +113,12 @@ Components showcased in `storybook/`
113113
- `lerna.json` - Monorepo configuration
114114
- `eslint.config.js` - ESLint flat config
115115
- `.prettierrc.json` - Prettier configuration
116+
- `.prettierignore` - Prettier exclusions (includes MDX files)
117+
- `.nvmrc` - Node version specification
116118
- `dev/config/jupyter_server_config.py` - Server settings
117119
- `packages/react/src/jupyter/JupyterContext.tsx` - Core context provider
118120
- `packages/react/src/state/JupyterReactState.ts` - Zustand store
121+
- `patches/` - Third-party module patches (applied via patch-package)
119122

120123
## CI/CD
121124

@@ -141,6 +144,8 @@ Components showcased in `storybook/`
141144
- Updated ESLint to v9 flat config format
142145
- Removed deprecated `.eslintignore` in favor of ignores in config
143146
- Added `--quiet` flag to lint command (show errors only)
147+
- Updated Node.js requirement from 18 to 20+
148+
- Added .nvmrc file for Node version management
144149

145150
### Code Quality Fixes
146151

@@ -152,6 +157,19 @@ Components showcased in `storybook/`
152157
- Replaced `Function` types with proper signatures
153158
- Added security attributes to external links (`rel="noreferrer"`)
154159

160+
### Storybook MDX Fixes
161+
162+
- Fixed malformed MDX comments from `{/_` to `{/**`
163+
- Updated all 13 MDX story files to use proper JSX comment syntax
164+
- Added MDX files to .prettierignore to prevent comment corruption
165+
166+
### Build & CI Improvements
167+
168+
- Fixed webpack source map warnings by excluding problematic packages
169+
- Created patch for @jupyterlite/javascript-kernel-extension missing logo files
170+
- Updated GitHub Actions workflows to use Node 20
171+
- Added patch-package for third-party module fixes
172+
155173
## Troubleshooting
156174

157175
### Common Issues
@@ -168,6 +186,15 @@ Components showcased in `storybook/`
168186
- Ensure Jupyter server is running on port 8686
169187
- Check token in server config
170188

189+
4. **Storybook build errors**
190+
- Check MDX comment syntax (must be `{/** **/}`)
191+
- Verify patches are applied: `npx patch-package`
192+
- Missing logo files error fixed by @jupyterlite patch
193+
194+
5. **Node version issues**
195+
- Use Node 20+ (check with `node --version`)
196+
- Use .nvmrc file: `nvm use`
197+
171198
## Notes for AI Assistants
172199

173200
- The `attic/` folder contains archived/experimental code - do not modify

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Thank you for your interest in contributing to Jupyter UI! We welcome all contri
66

77
Before you begin, ensure you have the following installed:
88

9-
- **Node.js** >= 18.0.0 (preferably the LTS version)
9+
- **Node.js** >= 20.0.0 (preferably the LTS version)
1010
- **npm** >= 8.0.0
11-
- **Python** >= 3.8 (for running Jupyter server)
11+
- **Python** >= 3.9 (for running Jupyter server)
1212
- **Git** >= 2.0.0
1313

1414
## 🚀 Development Setup

0 commit comments

Comments
 (0)