Skip to content

Polish README for GTM (GTM-01)#552

Merged
Chris0Jeky merged 2 commits intomainfrom
gtm/polish-readme
Mar 29, 2026
Merged

Polish README for GTM (GTM-01)#552
Chris0Jeky merged 2 commits intomainfrom
gtm/polish-readme

Conversation

@Chris0Jeky
Copy link
Copy Markdown
Owner

Summary

  • Restructures README with clear sections: hero statement, How It Works table, Quick Start, key concepts, contributing
  • Adds CI build badge (pointing to ci-required.yml) and MIT license badge
  • Adds GIF placeholder comment for future demo visual
  • Aligns copy with the thesis (local-first, review-first, near-zero-friction capture) drawing from docs/product/LANDING_COPY.md
  • Adds "What Taskdeck Is NOT" section for positioning clarity
  • Adds release version roadmap table
  • Closes GTM-01: Polish GitHub README with demo GIF, install steps, and value proposition #545

Test plan

  • README renders correctly in GitHub preview
  • CI badge links to the correct workflow (ci-required.yml)
  • License badge links to LICENSE file (will resolve once GTM-05: Add LICENSE file to repository #547 adds MIT license)
  • GIF placeholder comment <!-- demo GIF will be added here --> is present
  • All internal doc links are valid (docs/START_HERE.md, docs/STATUS.md, AGENTS.md, etc.)
  • "What Taskdeck Is NOT" section is present and accurate
  • Quick Start commands match CLAUDE.md instructions

Restructures README with clear hero statement, How It Works table,
Quick Start, What It Is NOT section, and key concepts. Adds CI badge,
MIT license badge, and GIF placeholder. Copy is drawn from
docs/product/LANDING_COPY.md and aligned with the review-first thesis.

Closes #545
@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

@Chris0Jeky
Copy link
Copy Markdown
Owner Author

Self-review findings:

Badges

Copy accuracy

  • "Nothing changes without your approval" — accurately describes shipped review-first behavior.
  • "Your data stays on your machine" — accurate; SQLite local-first is shipped.
  • "The core capture → triage → review → apply loop is shipped and stable" — accurate per STATUS.md.
  • Quick Start commands match CLAUDE.md exactly.
  • Roadmap version table is drawn from STATUS.md platform expansion strategy (v0.1.0–v1.0.0).

What was removed

  • Internal planning notes (issue references like #213, #235–240) were removed from the public README. These were contributor-facing internal state, not appropriate for a public-facing README. They remain in docs/STATUS.md where they belong.

GIF placeholder

  • Present as <!-- demo GIF will be added here --> directly below the badges/tagline as requested.

What Taskdeck Is NOT

  • Present and accurate — "Not a cloud SaaS (yet)", "Not a team platform", "Not an autonomous AI agent".

Minor issues found

  • Table column alignment in | Layer | Technology | is slightly uneven in raw markdown but renders fine on GitHub.
  • dotnet restore step was dropped from Quick Start — it is implied by dotnet run but could be made explicit for first-time users. Low priority since dotnet run triggers restore automatically in .NET 8.

Action required before merge

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request performs a comprehensive overhaul of the README.md file to improve project clarity and onboarding. Key updates include a more concise value proposition, the addition of 'How It Works' and 'What Taskdeck Is NOT' sections, and the restructuring of technical details like the tech stack and roadmap into readable tables. The quick start guide was also streamlined to facilitate easier local setup. I have no feedback to provide as there were no review comments.

@Chris0Jeky Chris0Jeky merged commit c75dadd into main Mar 29, 2026
10 checks passed
@github-project-automation github-project-automation bot moved this from Pending to Done in Taskdeck Execution Mar 29, 2026
@Chris0Jeky Chris0Jeky deleted the gtm/polish-readme branch March 29, 2026 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

GTM-01: Polish GitHub README with demo GIF, install steps, and value proposition

1 participant