Skip to content

Remove non working web examples#364

Merged
yamcodes merged 2 commits intomainfrom
remove-non-working-examples
Nov 12, 2025
Merged

Remove non working web examples#364
yamcodes merged 2 commits intomainfrom
remove-non-working-examples

Conversation

@yamcodes
Copy link
Owner

@yamcodes yamcodes commented Nov 12, 2025

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

    • Updated examples documentation to reflect the current set of available example projects and carefully revised the example directory path format guidance provided in code samples and reference tables
  • Chores

    • Removed two example projects from the workspace configuration, eliminating all their associated project setup files, configuration files, build scripts, and related documentation

- Removed with-bun-react example
- Removed with-vite-react-ts example
- Updated examples README
@changeset-bot
Copy link

changeset-bot bot commented Nov 12, 2025

⚠️ No Changeset found

Latest commit: 59e09d1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Nov 12, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
arkenv Ready Ready Preview Comment Nov 12, 2025 6:06pm

@github-actions github-actions bot added docs Improvements or additions to documentation example Issues or Pull Requests concerning at least one ArkEnv example. (Found in the `examples/` directory) labels Nov 12, 2025
@yamcodes yamcodes changed the title Remove non working examples Remove non working web examples Nov 12, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 12, 2025

Walkthrough

This PR removes two complete example projects from the repository: with-bun-react and with-vite-react-ts. All associated files, configuration, components, and documentation for these examples are deleted. The workspace configuration and examples README are updated accordingly to reflect their removal.

Changes

Cohort / File(s) Summary
Workspace and Documentation Updates
arkenv.code-workspace, examples/README.md
Removed workspace entries for with-bun-react, with-bun-react, and with-vite-react-ts; updated examples table and documentation path format in README.
with-bun-react Example Deletion
.cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc, .env.example, .gitignore, README.md, build.ts, bun-env.d.ts, bunfig.toml, components.json, package.json, src/APITester.tsx, src/App.tsx, src/config/env.ts, src/components/env-display.tsx, src/components/ui/button.tsx, src/components/ui/card.tsx, src/components/ui/form.tsx, src/components/ui/input.tsx, src/components/ui/label.tsx, src/components/ui/select.tsx, src/frontend.tsx, src/index.css, src/index.html, src/index.tsx, src/lib/utils.ts, styles/globals.css, tsconfig.json
Complete removal of all files and directories within the Bun + React example project, including configuration, React components, UI primitives, build scripts, environment setup, and styling.
with-vite-react-ts Example Deletion
.env.development, .env.production, .gitignore, README.md, index.html, package.json, src/App.css, src/App.tsx, src/index.css, src/main.tsx, src/vite-env.d.ts, tsconfig.app.json, tsconfig.json, tsconfig.node.json, vite.config.ts
Complete removal of all files and directories within the Vite + React + TypeScript example project, including environment configs, HTML entry point, React components, stylesheets, and TypeScript/Vite configurations.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

  • Volume: The PR affects 50+ files across two example directories, making comprehensive verification time-consuming despite the straightforward nature of the deletions.
  • Consistency check: Verify that removal of workspace entries and README updates are aligned and complete; confirm no dangling references exist in other documentation or configuration files.
  • Exported API removal: Both projects exported React components, utilities, and configurations; confirm no consumers or tests still depend on these deleted modules.

Possibly related PRs

  • Add Bun + React playground and example #285: Directly related as it adds the same example directories (with-bun-react, with-vite-react-ts) and components that this PR removes, representing opposing changes.
  • Integration tests #108: References the examples/with-vite-react-ts example in integration tests or test fixtures that may be affected by its removal.

Poem

🐰 Two examples hop away,
Bun and Vite bid their day,
Workspace cleaner, trimmed with care,
Fresh examples fill the air! 🌿✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Remove non working examples' directly describes the primary change: deletion of non-functional example directories (with-bun-react and with-vite-react-ts) and their workspace references.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch remove-non-working-examples

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 and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md or 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

📥 Commits

Reviewing files that changed from the base of the PR and between cbb85cc and 59e09d1.

⛔ Files ignored due to path filters (6)
  • examples/with-bun-react/bun.lock is excluded by !**/*.lock
  • examples/with-bun-react/src/logo.svg is excluded by !**/*.svg
  • examples/with-bun-react/src/react.svg is excluded by !**/*.svg
  • examples/with-vite-react-ts/package-lock.json is excluded by !**/package-lock.json
  • examples/with-vite-react-ts/public/vite.svg is excluded by !**/*.svg
  • examples/with-vite-react-ts/src/assets/react.svg is 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 (basic and with-bun). The removed entries (with-bun-react and with-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.

@yamcodes yamcodes merged commit 8fad0a1 into main Nov 12, 2025
15 checks passed
@yamcodes yamcodes deleted the remove-non-working-examples branch November 12, 2025 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation example Issues or Pull Requests concerning at least one ArkEnv example. (Found in the `examples/` directory)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant