Conversation
- Removed with-bun-react example - Removed with-vite-react-ts example - Updated examples README
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughThis PR removes two complete example projects from the repository: Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Possibly related PRs
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
examples/README.md (1)
1-27: Consider whether other documentation references removed examples.Per the learnings from PR #132, documentation should reference runtime support with specific examples. If
packages/arkenv/README.mdor other top-level documentation previously linked to the removed Vite example for runtime support documentation, those references may need updating. This is outside the scope of this file but worth verifying to prevent broken documentation links.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (6)
examples/with-bun-react/bun.lockis excluded by!**/*.lockexamples/with-bun-react/src/logo.svgis excluded by!**/*.svgexamples/with-bun-react/src/react.svgis excluded by!**/*.svgexamples/with-vite-react-ts/package-lock.jsonis excluded by!**/package-lock.jsonexamples/with-vite-react-ts/public/vite.svgis excluded by!**/*.svgexamples/with-vite-react-ts/src/assets/react.svgis excluded by!**/*.svg
📒 Files selected for processing (43)
arkenv.code-workspace(0 hunks)examples/README.md(1 hunks)examples/with-bun-react/.cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc(0 hunks)examples/with-bun-react/.env.example(0 hunks)examples/with-bun-react/.gitignore(0 hunks)examples/with-bun-react/README.md(0 hunks)examples/with-bun-react/build.ts(0 hunks)examples/with-bun-react/bun-env.d.ts(0 hunks)examples/with-bun-react/bunfig.toml(0 hunks)examples/with-bun-react/components.json(0 hunks)examples/with-bun-react/package.json(0 hunks)examples/with-bun-react/src/APITester.tsx(0 hunks)examples/with-bun-react/src/App.tsx(0 hunks)examples/with-bun-react/src/components/env-display.tsx(0 hunks)examples/with-bun-react/src/components/ui/button.tsx(0 hunks)examples/with-bun-react/src/components/ui/card.tsx(0 hunks)examples/with-bun-react/src/components/ui/form.tsx(0 hunks)examples/with-bun-react/src/components/ui/input.tsx(0 hunks)examples/with-bun-react/src/components/ui/label.tsx(0 hunks)examples/with-bun-react/src/components/ui/select.tsx(0 hunks)examples/with-bun-react/src/config/env.ts(0 hunks)examples/with-bun-react/src/frontend.tsx(0 hunks)examples/with-bun-react/src/index.css(0 hunks)examples/with-bun-react/src/index.html(0 hunks)examples/with-bun-react/src/index.tsx(0 hunks)examples/with-bun-react/src/lib/utils.ts(0 hunks)examples/with-bun-react/styles/globals.css(0 hunks)examples/with-bun-react/tsconfig.json(0 hunks)examples/with-vite-react-ts/.env.development(0 hunks)examples/with-vite-react-ts/.env.production(0 hunks)examples/with-vite-react-ts/.gitignore(0 hunks)examples/with-vite-react-ts/README.md(0 hunks)examples/with-vite-react-ts/index.html(0 hunks)examples/with-vite-react-ts/package.json(0 hunks)examples/with-vite-react-ts/src/App.css(0 hunks)examples/with-vite-react-ts/src/App.tsx(0 hunks)examples/with-vite-react-ts/src/index.css(0 hunks)examples/with-vite-react-ts/src/main.tsx(0 hunks)examples/with-vite-react-ts/src/vite-env.d.ts(0 hunks)examples/with-vite-react-ts/tsconfig.app.json(0 hunks)examples/with-vite-react-ts/tsconfig.json(0 hunks)examples/with-vite-react-ts/tsconfig.node.json(0 hunks)examples/with-vite-react-ts/vite.config.ts(0 hunks)
💤 Files with no reviewable changes (42)
- examples/with-bun-react/src/APITester.tsx
- examples/with-vite-react-ts/.env.development
- examples/with-vite-react-ts/README.md
- examples/with-bun-react/src/index.html
- examples/with-bun-react/src/index.css
- examples/with-bun-react/src/components/ui/label.tsx
- examples/with-bun-react/src/config/env.ts
- examples/with-vite-react-ts/package.json
- examples/with-bun-react/bunfig.toml
- examples/with-bun-react/.cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc
- examples/with-bun-react/.gitignore
- examples/with-bun-react/tsconfig.json
- examples/with-vite-react-ts/src/App.tsx
- arkenv.code-workspace
- examples/with-bun-react/src/components/ui/button.tsx
- examples/with-bun-react/package.json
- examples/with-bun-react/components.json
- examples/with-bun-react/src/components/ui/input.tsx
- examples/with-vite-react-ts/vite.config.ts
- examples/with-vite-react-ts/tsconfig.app.json
- examples/with-bun-react/src/components/ui/select.tsx
- examples/with-vite-react-ts/.env.production
- examples/with-bun-react/bun-env.d.ts
- examples/with-vite-react-ts/src/main.tsx
- examples/with-vite-react-ts/src/vite-env.d.ts
- examples/with-bun-react/.env.example
- examples/with-vite-react-ts/tsconfig.json
- examples/with-bun-react/README.md
- examples/with-bun-react/src/lib/utils.ts
- examples/with-vite-react-ts/tsconfig.node.json
- examples/with-vite-react-ts/index.html
- examples/with-bun-react/src/components/ui/form.tsx
- examples/with-vite-react-ts/src/index.css
- examples/with-bun-react/src/index.tsx
- examples/with-vite-react-ts/.gitignore
- examples/with-bun-react/src/components/env-display.tsx
- examples/with-vite-react-ts/src/App.css
- examples/with-bun-react/styles/globals.css
- examples/with-bun-react/build.ts
- examples/with-bun-react/src/frontend.tsx
- examples/with-bun-react/src/components/ui/card.tsx
- examples/with-bun-react/src/App.tsx
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: yamcodes
Repo: yamcodes/arkenv PR: 132
File: packages/arkenv/README.md:13-14
Timestamp: 2025-09-09T17:37:19.650Z
Learning: For yamcodes/arkenv project: Runtime support documentation should link to specific examples: Node.js (examples/basic), Bun (examples/with-bun), Vite (examples/with-vite-react-ts).
📚 Learning: 2025-09-09T17:37:19.650Z
Learnt from: yamcodes
Repo: yamcodes/arkenv PR: 132
File: packages/arkenv/README.md:13-14
Timestamp: 2025-09-09T17:37:19.650Z
Learning: For yamcodes/arkenv project: Runtime support documentation should link to specific examples: Node.js (examples/basic), Bun (examples/with-bun), Vite (examples/with-vite-react-ts).
Applied to files:
examples/README.md
🔇 Additional comments (2)
examples/README.md (2)
7-11: Examples table correctly reflects removal of non-working examples.The table now accurately lists only the functioning examples (
basicandwith-bun). The removed entries (with-bun-reactandwith-vite-react-ts) are appropriately deleted, aligning with the PR objective to remove examples pending resolution of issues #181, #195, #242, and #288.
22-27: Generalized structure example improves flexibility for future examples.The structure documentation now uses a generic
with-<tool-1>-...<tool-n>/pattern instead of specific example names, making it more adaptable for new examples.
We're removing examples that show web flows that aren't fully working with ArkEnv, due to issues like #181, #195, #242 and #288.
When more of these issues are fixed and we're ready to call web environments "supported environments", we will bring those examples back. For now, they live in the protected non-working-examples branch.
Summary by CodeRabbit
Documentation
Chores