Skip to content

(v1) Add root README.md for v1 branch GitHub landing page #1305

Description

@yamcodes

Problem

The v1 branch root README.md is a 25-byte stub containing only packages/arkenv/README.md. GitHub renders this literally, so visitors to the v1 branch see useless text instead of a project landing page.

On main, the same stub exists but is less noticeable because packages/arkenv/README.md there is a full marketing README. On v1, that package README is CLI-focused dev documentation — making the GitHub landing page especially poor.

Desired behavior

Replace the root README.md on the v1 branch only with a full, inlined marketing-style README (same structure as main's packages/arkenv/README.md), adapted for v1:

  • Install command: npx arkenv@latest init (and equivalent pnpm/yarn/bun variants)
  • Alpha callout: Prominent note at the top linking to the v1 roadmap (#683)
  • Doc links: Point to the alpha preview at https://arkenv-v1.vercel.app/docs/...
  • Branch-aware URLs: CI badge (branch=v1), StackBlitz (tree/v1/...), GitHub blob links (blob/v1/...)
  • Shared assets: Logo and demo GIF on arkenv.js.org can remain unchanged

Leave packages/arkenv/README.md unchanged — it serves as the npm package README and should stay CLI-focused.

Acceptance criteria

  • Root README.md on v1 renders as a full GitHub landing page (not the stub text)
  • Install commands use arkenv (not @arkenv/cli)
  • Docs/FAQ/quickstart links point to arkenv-v1.vercel.app
  • Alpha/pre-release callout references v1 Roadmap #683
  • CI badge, StackBlitz, and GitHub blob links are branch-aware (v1)
  • packages/arkenv/README.md is not modified
  • main branch is not modified

Out of scope

Related

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsAdds or changes documentation, or acts as documentation in and of itselfenhancementNew feature or improvementmarketingRelated to marketing, press, advertising, and user acquisitionready for agentFully specified, ready for immediate implementation

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions