Skip to content

[Change] docs-new-user-onboarding: vibe-coder uvx entry path + wow-path CLI fixes #476

@djm81

Description

@djm81

Why

User feedback and direct testing show two cohorts at docs.specfact.io: vibe coders want one command and a scored result in seconds; experienced developers can navigate pip, profiles, and modules. Today the site speaks mainly to the second group: the hero uses internal vocabulary before any runnable command, code review run is not above the fold, and the uvx path was paired with discouraging “limitations” copy.

The intended vibe-coder sequence is:

uvx specfact-cli init --profile solo-developer
uvx specfact-cli code review run --path . --scope full

This OpenSpec change delivers blocking CLI fixes (profile install, pip-free install under uvx, solo-developer including code-review), module UX (multi install/uninstall/upgrade, clearer errors), and docs aligned with that path (homepage, installation, quickstart).

What changes

CLI (summary)

  • init --profile installs the profile’s bundles and prints an Installed: … confirmation line.
  • Module installation works without relying on pip in uvx-isolated environments where appropriate.
  • solo-developer profile includes both specfact-codebase and specfact-code-review.
  • module install / module uninstall accept multiple positional IDs/names; module upgrade supports selective names, --yes, and major-bump handling; multi-uninstall continues after a failed name and exits non-zero if any step failed (typer.Exit / click.exceptions.Exit handling).
  • Module-not-found guidance includes a copy-pasteable uvx specfact-cli init --profile solo-developer (and pip path where relevant).

Docs

  • docs/index.md — outcome-first hero, uvx two-command block, three outcome-oriented path cards.
  • docs/getting-started/installation.md — “Try it now” / persistent install / more options; profile table updated for solo-developer.
  • docs/getting-started/quickstart.md — uvx-led intro aligned with vibe-coder flow.

Specs

  • Spec deltas live under openspec/changes/docs-new-user-onboarding/specs/; merge to main openspec/specs/ per project OpenSpec workflow when ready.

Hierarchy and related work

  • Parent feature (track here): #356 — documentation / discrepancy remediation epic; this issue is a user story under that umbrella.
  • Related (onboarding overlap): #466 — first-contact / onboarding story; coordinate messaging and scope.

Acceptance criteria (high level)

  • Wow path works: uvx init for solo-developer then code review run with scoped usage as documented.
  • Docs and README stay consistent with actual CLI behavior.
  • OpenSpec tasks + TDD_EVIDENCE.md satisfied before merge; PR targets dev.

OpenSpec change proposal: docs-new-user-onboardingopenspec/changes/docs-new-user-onboarding/

Metadata

Metadata

Assignees

Labels

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions