Skip to content

[task] Clarify current scaffold status in README #3

@phongndo

Description

@phongndo

Area

Docs

Goal

Make the README honest about the current state of the project: Nexgit is an early scaffold, not a working GitHub/repo manager yet.

Why this matters

New contributors should not be asked to document screenshots or working examples that do not exist. The README should help students understand what is real today, what is placeholder behavior, and where the first useful product work starts.

Relevant files

  • README.md
  • docs/product/README.md
  • docs/product/foundation/vision.md
  • apps/cli/src/main.rs
  • apps/cli/src/tui/ui.rs
  • apps/desktop/src/renderer/src/App.tsx

Depends on

None. This can be claimed immediately.

Current behavior

The project has setup docs, product direction, a Rust CLI/TUI scaffold, and an Electron desktop scaffold.

The project does not yet have a real working repo manager experience. Repo status is still placeholder behavior until the core repo-status issues land.

Target behavior

README includes a short Current status or similar section that says plainly:

  • Nexgit is an early scaffold.
  • The current CLI, TUI, and desktop surfaces are not the finished product.
  • Repo-status behavior is placeholder until the Contributor MVP issues land.
  • Contributors should use the v0.1.0 - Contributor MVP milestone to find real implementation work.

Out of scope

  • Do not add screenshots of unfinished UI.
  • Do not present placeholder output as a finished feature.
  • Do not implement CLI, TUI, desktop, or repo-status behavior.
  • Do not rewrite the full README or product vision.

Definition of done

  • README clearly states the project is currently a scaffold.
  • README points contributors toward the Contributor MVP milestone for real work.
  • The wording is concise and does not make the project look more complete than it is.
  • Existing setup instructions remain intact.

Verification

  • pnpm format:prettier:check
  • Manually review the README rendered on GitHub or in a Markdown preview.
  • Confirm the README no longer implies there is a working product demo.

Contributor notes

This is a good first issue because it is a small docs task with a clear boundary. The main job is honesty and clarity, not marketing.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: docsProject documentation and contributor guidance.good first issueA scoped task that is suitable for a first contribution.good for beginnerA student-friendly starter task with clear scope, success criteria, and verification steps.kind: docsDocumentation-only changes or issues.

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions