Skip to content

docs: (v1) Add root README.md for v1 branch GitHub landing page#1310

Merged
yamcodes merged 4 commits into
v1from
1305-v1-add-root-readmemd-for-v1-branch-github-landing-page
Jul 12, 2026
Merged

docs: (v1) Add root README.md for v1 branch GitHub landing page#1310
yamcodes merged 4 commits into
v1from
1305-v1-add-root-readmemd-for-v1-branch-github-landing-page

Conversation

@yamcodes

Copy link
Copy Markdown
Owner

Fixes #1305

Summary

  • Replaces the root README.md on the v1 branch — previously a symlink to packages/arkenv/README.md, which GitHub renders as the literal stub text packages/arkenv/README.md — with a full, inlined marketing-style landing page based on main's packages/arkenv/README.md.

v1-specific adaptations

  • Alpha callout at the top linking to the v1 roadmap (v1 Roadmap #683)
  • Install tabs (npm/pnpm/Yarn/Bun) use arkenv instead of @arkenv/cli (e.g. npx arkenv@latest init)
  • Docs, FAQ, and quickstart links point to the alpha preview at arkenv-v1.vercel.app (all verified to resolve with HTTP 200)
  • CI badge uses branch=v1, StackBlitz uses tree/v1/..., and GitHub blob links use blob/v1/...
  • Shared CDN assets (logo, demo GIF on arkenv.js.org) unchanged
  • packages/arkenv/README.md is untouched (remains the CLI-focused npm README)

Validation

  • pnpm run typecheck
  • pnpm run test ✅ (796 tests passed)
  • pnpm run fix ✅ (no changes to the new README)

Made with Cursor

Co-authored-by: Cursor <cursoragent@cursor.com>
@yamcodes yamcodes added docs Adds or changes documentation, or acts as documentation in and of itself enhancement New feature or improvement marketing Related to marketing, press, advertising, and user acquisition labels Jul 12, 2026
@changeset-bot

changeset-bot Bot commented Jul 12, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: cda2fda

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

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Important

The v1 test badge image points to tests-badge.yml, which only mirrors test workflow runs for the dev branch, so the badge will not reflect v1 status.

Reviewed changes — replaced the root README.md symlink on the v1 branch with an inlined marketing landing page adapted from main's README.

  • Added root README.md — full landing page with v1 alpha callout, install tabs (npm/pnpm/Yarn/Bun), docs/FAQ/StackBlitz links, and contributor list.

⚠️ v1 test badge will show no status

The badge image at README.md:8 references tests-badge.yml, but that workflow only mirrors test runs when head_branch == 'dev' (.github/workflows/tests-badge.yml:19). On v1 the badge will show no status. Either point the badge image to test.yml for this branch, or extend tests-badge.yml to also mirror v1 runs.

Pullfrog  | Fix it ➔View workflow run | Using Kimi K2 (free via Pullfrog for OSS) | 𝕏

tests-badge.yml only mirrors dev branch runs, so the badge image showed
no status on v1. Use test.yml directly for the badge src instead.

Co-authored-by: Cursor <cursoragent@cursor.com>
@yamcodes

Copy link
Copy Markdown
Owner Author

Addressed the Pullfrog review in f0cda69.

The test badge image now points at test.yml directly (badge.svg?branch=v1) instead of tests-badge.yml, which only mirrors dev branch runs and would show no status on v1. The badge link target was already correct.

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

✅ No new issues found.

Reviewed changes — fixed the v1 test badge source so it reflects actual test.yml runs on the v1 branch.

  • Updated README.md badge image — changed the badge src from tests-badge.yml/badge.svg?branch=v1 to test.yml/badge.svg?branch=v1, matching the existing link href and ensuring the badge shows v1 CI status.

Pullfrog  | View workflow run | Using Kimi K2 (free via Pullfrog for OSS) | 𝕏

Split the combined Next.js/Nuxt twoslash test and give each case a 15s
timeout. Two sequential TypeScript compilations exceeded Vitest's default
5s limit on the LTS Node matrix job.

Co-authored-by: Cursor <cursoragent@cursor.com>
@yamcodes

Copy link
Copy Markdown
Owner Author

Fixed the failing test (lts/*) job in b91fddb.

Root cause: apps/www/lib/twoslash-options.test.ts ran two sequential Twoslash TypeScript compilations in one test, exceeding Vitest's default 5s timeout on the slower LTS Node matrix runner.

Fix: Split the combined test into separate Next.js and Nuxt cases, each with a 15s timeout.

@github-actions github-actions Bot added www Improvements or additions to arkenv.js.org tests This issue or PR is about adding, removing or changing tests labels Jul 12, 2026
@arkenv-bot

arkenv-bot Bot commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

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

Warning

Deployment cooldown active

@autofix-ci[bot] has triggered deployments too frequently. Please wait 18 minutes and 8 seconds before the next automated deployment.

⌛ How to resolve this issue?

After the wait time has elapsed, a deployment can be triggered by pushing new commits to this PR or by re-running the workflow.

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

🚦 How do rate limits work?

We enforce rate limits to ensure stability and fair usage of resources for all contributors.

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

✅ No new issues found.

Reviewed changes — since the prior review, the combined Next.js/Nuxt path-alias test was split into two tests with individual 15s timeouts to avoid CI flakiness.

  • Split apps/www/lib/twoslash-options.test.ts path-alias test — separated the Next.js (@/env/client) and Nuxt (~~/env/client) assertions into independent tests so each can carry its own timeout.
  • Added per-test timeout: 15_000 — gives the Twoslash snippets enough time on CI without raising the global timeout.

Pullfrog  | View workflow run | Using Kimi K2 (free via Pullfrog for OSS) | 𝕏

@yamcodes yamcodes merged commit 90c1df6 into v1 Jul 12, 2026
18 checks passed
@yamcodes yamcodes deleted the 1305-v1-add-root-readmemd-for-v1-branch-github-landing-page branch July 12, 2026 23:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Adds or changes documentation, or acts as documentation in and of itself enhancement New feature or improvement marketing Related to marketing, press, advertising, and user acquisition tests This issue or PR is about adding, removing or changing tests www Improvements or additions to arkenv.js.org

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant