Skip to content

docs/install: add explicit uninstall/reset path and simplify install decision tree #1554

@affaan-m

Description

@affaan-m

Summary

The repo already has uninstall lifecycle support (scripts/uninstall.js, ecc uninstall routing, install-state tracking), but the main install surface still feels confusing to users because the README emphasizes multiple install methods without a single dominant decision path or a visible cleanup/reset path.

Recent user feedback is consistent:

  • users stack plugin install plus manual/full install
  • users end up with duplicate ECC surfaces in ~/.claude and project folders
  • users do not know there is already an uninstall/reset path
  • users perceive hooks as invasive because they do not know how to disable or remove only the ECC-managed hook layer cleanly
  • the README install section is too deep and too branchy before it gives a simple recommendation

Problem

This is not primarily a missing-code problem. It is a product-surface problem:

  • too many install paths are presented too early
  • the dominant recommendation is not obvious
  • uninstall/reset is not prominent in the README quick start
  • plugin-install vs full-manual-install duplication is still easy to do accidentally

Proposed scope

README / docs

  • add one explicit recommended install path near the top
  • add a short install decision tree:
    • plugin install
    • fully manual install
    • selective/manual power-user install
  • add a prominent Uninstall / Reset ECC section near Quick Start and Troubleshooting
  • document how to remove only ECC-managed hooks without tearing down everything else
  • document clearly that plugin install and full install must not be stacked

CLI / UX

  • make the uninstall path discoverable from the top-level docs using the current implementation:
    • node scripts/uninstall.js --dry-run
    • node scripts/uninstall.js
    • ecc uninstall
  • if needed, add a short human-facing alias/help surface so users do not need to know the internal script name first

Support posture

  • update old duplication/install discussions with the canonical answer
  • stop leaving users to infer cleanup from issue threads or DM support

Acceptance criteria

  • a new user can answer "which install path should I use?" within the first screenful of install docs
  • a user who wants out can answer "how do I remove ECC cleanly?" within the first screenful of docs/troubleshooting
  • plugin + full-install duplication is warned against prominently, not buried
  • hook-only disable/remove guidance exists and is easy to find
  • at least one discussion thread about install duplication is updated with the canonical uninstall/reset answer

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions