Skip to content

(v1) Update v1 README links from alpha preview to production on v1 launch #1306

Description

@yamcodes

Summary

When ArkEnv v1 ships, the root README.md on the v1 branch will point documentation and preview URLs at the alpha preview deployment (https://arkenv-v1.vercel.app). Those links need to be updated to production URLs once v1 is released.

Blocked on v1 launch — see #683.

Current behavior (after #1305)

The v1 branch root README uses alpha/preview URLs for docs, FAQ, quickstart, and related navigation. An alpha callout links to the v1 roadmap.

Desired behavior

After v1 launches and docs are live at production:

  • Docs, FAQ, and quickstart links point to https://arkenv.js.org/docs/... (production paths)
  • Remove or replace the alpha/pre-release callout with stable-release messaging (or remove it entirely)
  • Re-evaluate StackBlitz, GitHub blob links, and CI badge URLs for post-launch branch defaults (main vs v1)
  • Confirm install commands reflect the published npm tag (latest vs next)

Acceptance criteria

  • All doc navigation links in the v1 root README resolve to production arkenv.js.org URLs
  • Alpha/pre-release callout is removed or updated to reflect stable v1
  • StackBlitz and GitHub blob links use the correct default branch after launch
  • Install commands match the published npm package/tag strategy at launch
  • No remaining references to arkenv-v1.vercel.app in the root README unless intentionally kept for a specific reason

Out of scope

  • Rewriting README marketing copy beyond URL/target updates
  • Changes to packages/arkenv/README.md unless npm publishing requires it
  • Fixing the root README stub on main (separate concern)

Related

Metadata

Metadata

Assignees

No one assigned

    Labels

    blockedWork cannot proceed; waiting on something elsedocsAdds or changes documentation, or acts as documentation in and of itselfenhancementNew feature or improvementmarketingRelated to marketing, press, advertising, and user acquisitionready for humanNeeds a judgment call or design decision before implementation

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions