Skip to content

Update URL to use js.org#112

Merged
yamcodes merged 7 commits intomainfrom
js.org
Sep 6, 2025
Merged

Update URL to use js.org#112
yamcodes merged 7 commits intomainfrom
js.org

Conversation

@yamcodes
Copy link
Owner

@yamcodes yamcodes commented Sep 6, 2025

Once js-org/js.org#10128 resolves:

  1. Merge this PR
  2. Update the URL in this repo's description
  3. Merge https://github.com/yamcodes/yamcodes-config-file/pull/1

Summary by CodeRabbit

  • Documentation
    • Updated documentation and example README links to use the new arkenv.js.org domain.
    • Refreshed live-site badges and docsite references for accurate navigation.
  • Chores
    • Updated package metadata to set arkenv.js.org as the homepage across packages.
    • Standardized project URLs for consistency and improved user navigation.

@changeset-bot
Copy link

changeset-bot bot commented Sep 6, 2025

⚠️ No Changeset found

Latest commit: fb70bfd

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 Sep 6, 2025

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

Project Deployment Preview Comments Updated (UTC)
arkenv Ready Ready Preview Comment Sep 6, 2025 5:24pm
arkenv-docs Ready Ready Preview Comment Sep 6, 2025 5:24pm

@github-actions github-actions bot added docs Improvements or additions to documentation arkenv Changes to the `arkenv` npm package. @arkenv/vite-plugin Issues or Pull Requests involving the Vite plugin for ArkEnv example Issues or Pull Requests concerning at least one ArkEnv example. (Found in the `examples/` directory) labels Sep 6, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 6, 2025

Warning

Rate limit exceeded

@yamcodes has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 23 minutes and 46 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 23b9ac2 and fb70bfd.

📒 Files selected for processing (8)
  • README.md (2 hunks)
  • apps/www/README.md (1 hunks)
  • apps/www/content/docs/README.md (1 hunks)
  • arkenv.code-workspace (1 hunks)
  • examples/basic/README.md (2 hunks)
  • examples/with-bun/README.md (2 hunks)
  • examples/with-vite-react-ts/README.md (1 hunks)
  • packages/vite-plugin/README.md (1 hunks)

Walkthrough

Replaced arkenv.vercel.app links with arkenv.js.org across READMEs and package.json metadata. No code, API, or runtime changes.

Changes

Cohort / File(s) Summary
Root README link update
README.md
Updated two links from arkenv.vercel.app to arkenv.js.org.
Docs README badges/links
apps/docs/README.md, apps/docs/content/docs/README.md
Switched documentation site URLs to arkenv.js.org.
Examples README doc links
examples/basic/README.md, examples/with-bun/README.md
Updated guide and next-steps links to arkenv.js.org (preserving paths/anchors).
Vite plugin README links
packages/vite-plugin/README.md
Replaced documentation links with arkenv.js.org.
Package metadata homepage
packages/arkenv/package.json, packages/vite-plugin/package.json
Changed homepage fields from https://arkenv.vercel.app to https://arkenv.js.org.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I hop through docs with nimble cheer,
Switching trails to paths more clear.
From vercel’s valley to js.org’s glen,
Links now point true for every warren.
Thump-thump! The README fields align—
Carrots of consistency, crisp and fine. 🥕

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch js.org

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: 1

🧹 Nitpick comments (1)
examples/basic/README.md (1)

51-51: LGTM; optional consistency tweak

Consider updating the “Next steps → ArkEnv docs” link (Line 77) to the docsite for consistency: https://arkenv.js.org.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ace41b1 and 2997e84.

📒 Files selected for processing (8)
  • README.md (2 hunks)
  • apps/docs/README.md (1 hunks)
  • apps/docs/content/docs/README.md (1 hunks)
  • examples/basic/README.md (1 hunks)
  • examples/with-bun/README.md (1 hunks)
  • packages/arkenv/package.json (1 hunks)
  • packages/vite-plugin/README.md (1 hunks)
  • packages/vite-plugin/package.json (1 hunks)
🧰 Additional context used
🧬 Code graph analysis (2)
packages/vite-plugin/package.json (2)
packages/vite-plugin/src/index.test.ts (1)
  • buildWithPlugin (25-37)
packages/vite-plugin/src/index.ts (1)
  • config (17-19)
packages/vite-plugin/README.md (2)
packages/vite-plugin/src/index.ts (1)
  • config (17-19)
packages/vite-plugin/src/index.test.ts (1)
  • it (121-174)
🔇 Additional comments (7)
README.md (1)

2-2: LGTM: domain switch to js.org

Anchor updated correctly to https://arkenv.js.org.

apps/docs/README.md (1)

5-5: LGTM: live-site link updated

Copy reads well; URL points to the new domain.

packages/vite-plugin/README.md (1)

83-83: LGTM: docs link and “homepage” field updated; ready for next release

apps/docs/content/docs/README.md (1)

5-5: LGTM: docsite URL switched

Consistent with the domain migration.

packages/vite-plugin/package.json (1)

35-35: Hold merge until JS.org DNS is live

  • rg shows no lingering arkenv.vercel.app links.
  • Homepage now correctly set on arkenv and @arkenv/vite-plugin.
  • Once the js.org PR/DNS is live, cut a patch release so npm picks up the new homepage.
  • Optional: update the GitHub repo description URL after merge.
examples/with-bun/README.md (1)

58-58: Confirm anchor availability once DNS is live. Examples reference https://arkenv.js.org/docs/guides/environment-configuration#using-env-files (examples/with-bun/README.md:58, examples/basic/README.md:51), but the site currently redirects/fails—please verify the #using-env-files anchor resolves correctly after DNS and certs are active.

packages/arkenv/package.json (1)

34-34: LGTM—ready to publish once arkenv.js.org is live. After the domain goes live, release a patch to update npm metadata to point to the new homepage.

@yamcodes
Copy link
Owner Author

yamcodes commented Sep 6, 2025

Actionable comments posted: 1

🧹 Nitpick comments (1)
examples/basic/README.md (1)

51-51: LGTM; optional consistency tweak

Consider updating the “Next steps → ArkEnv docs” link (Line 77) to the docsite for consistency: https://arkenv.js.org.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ace41b1 and 2997e84.

📒 Files selected for processing (8)
  • README.md (2 hunks)
  • apps/docs/README.md (1 hunks)
  • apps/docs/content/docs/README.md (1 hunks)
  • examples/basic/README.md (1 hunks)
  • examples/with-bun/README.md (1 hunks)
  • packages/arkenv/package.json (1 hunks)
  • packages/vite-plugin/README.md (1 hunks)
  • packages/vite-plugin/package.json (1 hunks)
🧰 Additional context used
🧬 Code graph analysis (2)
packages/vite-plugin/package.json (2)
packages/vite-plugin/src/index.test.ts (1)
  • buildWithPlugin (25-37)
packages/vite-plugin/src/index.ts (1)
  • config (17-19)
packages/vite-plugin/README.md (2)
packages/vite-plugin/src/index.ts (1)
  • config (17-19)
packages/vite-plugin/src/index.test.ts (1)
  • it (121-174)
🔇 Additional comments (7)
README.md (1)

2-2: LGTM: domain switch to js.org

Anchor updated correctly to https://arkenv.js.org.

apps/docs/README.md (1)

5-5: LGTM: live-site link updated

Copy reads well; URL points to the new domain.

packages/vite-plugin/README.md (1)

83-83: LGTM: docs link and “homepage” field updated; ready for next release

apps/docs/content/docs/README.md (1)

5-5: LGTM: docsite URL switched

Consistent with the domain migration.

packages/vite-plugin/package.json (1)

35-35: Hold merge until JS.org DNS is live

  • rg shows no lingering arkenv.vercel.app links.
  • Homepage now correctly set on arkenv and @arkenv/vite-plugin.
  • Once the js.org PR/DNS is live, cut a patch release so npm picks up the new homepage.
  • Optional: update the GitHub repo description URL after merge.
examples/with-bun/README.md (1)

58-58: Confirm anchor availability once DNS is live. Examples reference https://arkenv.js.org/docs/guides/environment-configuration#using-env-files (examples/with-bun/README.md:58, examples/basic/README.md:51), but the site currently redirects/fails—please verify the #using-env-files anchor resolves correctly after DNS and certs are active.

packages/arkenv/package.json (1)

34-34: LGTM—ready to publish once arkenv.js.org is live. After the domain goes live, release a patch to update npm metadata to point to the new homepage.

@coderabbitai implement the nitpick comment

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 6, 2025

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

@yamcodes I'll implement the nitpick comment by examining the current content and updating the link on Line 77.

Let me also get the full context around that line:

And let me search for any "Next steps" or "ArkEnv docs" references:


🏁 Script executed:

#!/bin/bash
# Examine the examples/basic/README.md file to see the current content around Line 77
cat -n examples/basic/README.md | grep -A5 -B5 "77:"

Length of output: 52


🏁 Script executed:

#!/bin/bash
# Get lines 70-80 to see the context around Line 77
sed -n '70,80p' examples/basic/README.md

Length of output: 330


🏁 Script executed:

#!/bin/bash
# Search for "Next steps" and "ArkEnv docs" patterns
rg -n "Next steps|ArkEnv docs" examples/basic/README.md

Length of output: 130


Perfect! I found the line that needs to be updated. On Line 77 of examples/basic/README.md, the "ArkEnv docs" link currently points to the GitHub repository instead of the documentation site. Here's the fix for consistency:

Current Line 77:

- [ArkEnv docs](https://github.com/yamcodes/arkenv)

Updated Line 77:

- [ArkEnv docs](https://arkenv.js.org)

This change makes the link consistent with the PR's objective of updating URLs to use the new arkenv.js.org domain and provides users with direct access to the documentation site rather than the GitHub repository.

… site URL at arkenv.js.org

- Changed the workspace name for the www app to "www (arkenv.js.org)".
- Updated documentation links in README files to point to the new site URL: https://arkenv.js.org/docs.

These changes ensure consistency across the project following the recent site migration.
- Consolidated example entries in the workspace configuration for clarity.
- Ensured consistent formatting and structure across all example paths.

These changes enhance the organization of the workspace, making it easier to navigate and manage examples.
@yamcodes yamcodes merged commit ace5ca8 into main Sep 6, 2025
7 of 8 checks passed
@yamcodes yamcodes deleted the js.org branch September 6, 2025 20:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

@arkenv/vite-plugin Issues or Pull Requests involving the Vite plugin for ArkEnv arkenv Changes to the `arkenv` npm package. 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