Skip to content

Improve README onboarding and troubleshooting flow #452

@carols12352

Description

@carols12352

Problem or use case

New users must jump across multiple sections/docs to understand:

  • what gets stored,
  • which strategy to choose,
  • what recovery order to follow.
  • limitations?

Desired behavior

Proposed solution

Update README.md to add:

At a Glance (storage + branch impact + quick command flow)
Strategy Decision Guide (manual-commit or auto-commit)
Security Quick Checklist (with link to security-and-privacy.md)
Recommended Recovery Flow in troubleshooting (status -> doctor -> status -> rewind -> reset)
Short entry for worktree index corruption after git gc --auto (link to KNOWN_LIMITATIONS.md)

Scope:
Documentation only, no code/behavior changes.

Alternatives or workarounds

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions