docs: distribution policy — git-clone now, veralang later (#737)

[chethanuk]

Pre-flight validation ahead of aallan#737.

Summary by CodeRabbit

• Documentation
  • Clarified installation guidance in the FAQ and README.
  • Explained that installation from a git clone is currently supported.
  • Noted that pip install vera installs an unrelated package and outlined the planned veralang package name.
  • Removed the completed distribution-policy documentation item from the roadmap.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: d6727b7b-03ee-4383-b9cd-3aed53c39b02

📥 Commits

Reviewing files that changed from the base of the PR and between 9301e51 and 6a3b1d5.

⛔ Files ignored due to path filters (1)

• docs/llms-full.txt is excluded by !docs/**

📒 Files selected for processing (3)

• FAQ.md
• README.md
• ROADMAP.md

💤 Files with no reviewable changes (1)

• ROADMAP.md

---

📝 Walkthrough

Walkthrough

Installation documentation now clarifies the supported git-clone workflow, warns that pip install vera targets an unrelated package, and identifies veralang as the planned future PyPI name. The corresponding roadmap item has been removed.

Changes

Distribution policy

Layer / File(s)	Summary
Installation guidance and roadmap update FAQ.md, README.md, ROADMAP.md	FAQ and README document the supported installation method and planned PyPI name, while ROADMAP removes the completed distribution-policy entry.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Suggested labels: docs

🚥 Pre-merge checks | ✅ 8

✅ Passed checks (8 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarises the docs change about current git-clone installation and future veralang PyPI distribution.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Changelog Covers Public-Surface Changes	✅ Passed	PASS: The diff only touches docs and roadmap files; no public-surface paths were changed, so CHANGELOG coverage wasn’t required.
Spec And Implementation Move Together	✅ Passed	No files under vera/ or spec/ changed; the PR only updates docs and roadmap, so there is no spec-implementation drift to check.
Diagnostics Carry An Error Code	✅ Passed	PASS: the PR only edits docs/roadmap text; the diff adds distribution-policy notes and no diagnostic definitions or changed diagnostics.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/issue-737-distribution-policy

Warning

Review ran into problems

🔥 Problems

Linked repositories: Public OSS repositories can only analyze public repositories installed in this organization. No linked repositories were analyzed; skipped aallan/vera-bench.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[gemini-code-assist]

Code Review

This pull request documents the project's distribution policy across several files, including FAQ.md, README.md, and docs/llms-full.txt. It clarifies that installing via pip install vera is unsupported because that name belongs to an unrelated package on PyPI, and notes that the future PyPI package name will be veralang. Additionally, the corresponding task has been removed from ROADMAP.md. There are no review comments, and I have no feedback to provide.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.