Skip to content

docs(readme): describe the Foldkit frontend - #339

Open
artile wants to merge 1 commit into
MapleTechLabs:mainfrom
tao-io:docs/readme-foldkit
Open

artile wants to merge 1 commit into
MapleTechLabs:mainfrom
tao-io:docs/readme-foldkit

Conversation

@artile

@artile artile commented Oct 24, 2026 •

Copy link
Copy Markdown

The React app was deleted in #336, but the README still described it. This PR updates the frontend parts to match apps/web-foldkit and CLAUDE.md:

  • Intro and overview: Foldkit instead of React
  • Frontend stack: Foldkit, flat route union in src/route.ts, @foldkit/ui, tailwind-variants, ProseMirror. Removed React 19, TanStack Router, React Aria and Plate.js
  • Project structure: apps/web-foldkit/ on port 3100 (from vite.config.ts), not apps/web/ on 3000
  • Real-time sync: TanStack DB collections, not TanStack Query

Docs only. oxfmt --check README.md passes.

Not changed here: the README still names Clerk as the auth provider. CLAUDE.md says auth now runs on Hazel auth (@yielded/auth), and Clerk only verifies Maple OAuth tokens. I left that for a separate change, because the setup wizard and the Clerk sections need a check by someone who knows the current auth flow.


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need.

Summary by CodeRabbit

  • Documentation
    • Updated the project overview and setup guide to reflect the current frontend framework, routing, editor, and real-time sync technologies.
    • Changed the documented web app directory name and local URL to port 3100.

The React app was deleted in MapleTechLabs#336, but the README still listed React 19,
TanStack Router, React Aria and Plate.js, and pointed at apps/web on port
3000. Describe apps/web-foldkit instead: Foldkit, @foldkit/ui, ProseMirror,
the flat route union, and the Vite dev port 3100.
@coderabbitai

coderabbitai Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 74ab3f9a-4e2c-43cf-b6fb-30d5a411cb0d
📥 Commits

Reviewing files that changed from the base of the PR and between 4fb8080 and 9c6fc26.

📒 Files selected for processing: 1
  • README.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

📝 Walkthrough

The README updates its framework and editor descriptions, frontend stack and project structure, local web URL, and reactive query documentation.

Changes: README updates

Layer / File(s) Summary
Update framework and setup descriptions
README.md
The README now describes Foldkit, ProseMirror, flat-union routing, the web-foldkit app on port 3100, and TanStack DB collections.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Other

Suggested reviewers: makisuo

Merge Risk: ⚪ Minimal · up to 9c6fc

The README changes are ready to merge.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly describes the main change: updating the README to document the Foldkit frontend.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

This branch has not been deployed

No deployments
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