-
Notifications
You must be signed in to change notification settings - Fork 6
(v1) Add root README.md for v1 branch GitHub landing page #1305
Copy link
Copy link
Closed
Labels
docsAdds or changes documentation, or acts as documentation in and of itselfAdds or changes documentation, or acts as documentation in and of itselfenhancementNew feature or improvementNew feature or improvementmarketingRelated to marketing, press, advertising, and user acquisitionRelated to marketing, press, advertising, and user acquisitionready for agentFully specified, ready for immediate implementationFully specified, ready for immediate implementation
Milestone
Description
Metadata
Metadata
Assignees
Labels
docsAdds or changes documentation, or acts as documentation in and of itselfAdds or changes documentation, or acts as documentation in and of itselfenhancementNew feature or improvementNew feature or improvementmarketingRelated to marketing, press, advertising, and user acquisitionRelated to marketing, press, advertising, and user acquisitionready for agentFully specified, ready for immediate implementationFully specified, ready for immediate implementation
Problem
The
v1branch rootREADME.mdis a 25-byte stub containing onlypackages/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 becausepackages/arkenv/README.mdthere is a full marketing README. Onv1, that package README is CLI-focused dev documentation — making the GitHub landing page especially poor.Desired behavior
Replace the root
README.mdon thev1branch only with a full, inlined marketing-style README (same structure asmain'spackages/arkenv/README.md), adapted for v1:npx arkenv@latest init(and equivalent pnpm/yarn/bun variants)https://arkenv-v1.vercel.app/docs/...branch=v1), StackBlitz (tree/v1/...), GitHub blob links (blob/v1/...)arkenv.js.orgcan remain unchangedLeave
packages/arkenv/README.mdunchanged — it serves as the npm package README and should stay CLI-focused.Acceptance criteria
README.mdonv1renders as a full GitHub landing page (not the stub text)arkenv(not@arkenv/cli)arkenv-v1.vercel.appv1)packages/arkenv/README.mdis not modifiedmainbranch is not modifiedOut of scope
main(separate follow-up)packages/arkenv/README.mdRelated