Skip to content

Commit 5320660

Browse files
docs: cleanup with research
1 parent af98e0e commit 5320660

File tree

4 files changed

+165
-48
lines changed

4 files changed

+165
-48
lines changed

ROADMAP.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,2 @@
11
# Roadmap
22

3-
The project will evolve to support a web-based MDX notebook environment. High level goals:
4-
5-
- Build an interactive notebook system using **Next.js 13** with an App Router.
6-
- Use **MDX** to author notebook content and render code cells as React components.
7-
- Provide a **Monaco** based editor for each code cell with live preview.
8-
- Run user code in a **sandboxed iframe** or Web Worker for security.
9-
- Integrate **jest-lite** or similar to allow test cells with `describe`, `it`, and `expect`.
10-
- Store notebooks in **Payload CMS** backed by SQLite by default.
11-
- Offer CLI commands in `mdxe` to create, edit, and serve notebooks.

TODO.md

Lines changed: 0 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,2 @@
11
# TODO
22

3-
## Blocking Issues
4-
5-
### CI Test Script Missing
6-
7-
The CI checks are failing because there's no `test` script defined in the root package.json, but the CI workflow is trying to run `pnpm test`. This needs to be addressed to allow CI checks to pass for PRs in this repository.
8-
9-
## MDX-13: Architectural Update to Embed Next.js App with Payload CMS
10-
11-
### Completed
12-
- [x] Modified CLI implementation to run an embedded Next.js app directly
13-
- [x] Created embedded Next.js app structure in the mdxe package
14-
- [x] Integrated Payload CMS with SQLite as the default database
15-
- [x] Implemented serverless Payload routes for API endpoints
16-
- [x] Enhanced MDX component extension system
17-
- [x] Configured build and deployment strategies
18-
- [x] Updated pnpm-lock.yaml to match package.json changes
19-
20-
### Remaining Challenges
21-
- [ ] Resolve webpack configuration issues with Payload CMS admin UI
22-
- [ ] Fix TypeScript definition files and binary files handling in node_modules
23-
- [ ] Improve error handling for Payload CMS integration
24-
- [ ] Add comprehensive tests for the embedded Next.js app
25-
- [ ] Create documentation for the new architecture
26-
27-
### Verification Requirements
28-
- [x] CLI successfully finds and renders markdown content from user's directory
29-
- [x] Embedded Next.js app structure is in place
30-
- [x] MDX component extension system works for basic content
31-
- [ ] Payload CMS admin UI loads correctly
32-
- [ ] Build process properly handles output location for various deployment scenarios
33-
34-
### Deployment Status
35-
- [x] Vercel deployment is passing
36-
- [ ] Tests are failing due to unrelated TypeScript errors in mdxld package

0 commit comments

Comments
 (0)