Skip to content

Add honest Limits section to README before public launch - #12

Merged
Laaaaksh merged 1 commit into
mainfrom
fm/readme-pageflag
Aug 30, 2026
Merged

Laaaaksh merged 1 commit into
mainfrom
fm/readme-pageflag

Conversation

@Laaaaksh

Copy link
Copy Markdown
Owner

Summary

  • Pageflag's README already tracked the shared repo template closely (banner, badge row, one-line pitch, demo GIF above the fold, install/usage/configuration in order) - this PR adds the one required section it was missing: a plain Limits section, stating what the tool doesn't do (issue-tracker scope, screenshot-only capture, no kanban board, no browser extension, thinner dashboard test coverage than the server's, and no production deployments yet). Linked from the quick-nav line.
  • Backfilled a CHANGELOG ### Fixed entry for the thumbnail-crop and dead-issue-deep-link bugs the pre-launch audit found and Fix screenshot thumbnail crop and dead issue deep-link before public launch #11 already fixed in code - CONTRIBUTING.md's own workflow rule requires a changelog bullet for user-facing fixes, and this one was missed.
  • No application code touched, no behavior changed - README/CHANGELOG only.

Test plan

  • Read /Users/laksh/firstmate/data/verify-pageflag/report.md in full; confirmed both bugs it flagged (§3 thumbnail crop, §4 dead deep-link) are already fixed in 544f76b, and that no README claim currently outruns what the audit verified.
  • Checked every relative link in README.md/CONTRIBUTING.md/SECURITY.md/CHANGELOG.md resolves to a real file.
  • Confirmed LICENSE (MIT, correct author/year) matches the README's license badge and claim.
  • Extracted frames from docs/assets/pageflag-demo.gif and confirmed it's a genuine capture that still reflects current behavior (dashboard thumbnail shows real content, not the blank-box bug).
  • Scanned all touched/adjacent docs for placeholder or leftover-scaffolding text - none found.
  • README word count (945) sits inside the portfolio template's 800-1500 word guidance.

🤖 Generated with Claude Code

https://claude.ai/code/session_019vpjMJ1e8Sr8roPcYQUDwh

Pageflag's README already followed the shared repo template closely
(quick nav, badge row, demo GIF, install/usage/configuration in order),
but had no section stating what it doesn't do - the brief for making
this repo public requires one. Added Limits (issue-tracker scope,
screenshot-only capture, no kanban board, no browser extension, thinner
dashboard test coverage than the server, and no production users yet -
verified only by an independent pre-launch audit) between Configuration
and Changelog, and linked it from the quick-nav line.

Also backfilled a CHANGELOG Fixed entry for the thumbnail-crop and
dead-issue-deep-link bugs that same audit found and a prior commit
(544f76b) already fixed in code, per CONTRIBUTING.md's own rule that
user-facing fixes get a changelog bullet.

Verified every relative link in README/CONTRIBUTING/SECURITY/CHANGELOG
resolves, the LICENSE file matches the README's MIT claim, and the
demo GIF still reflects the current (fixed) thumbnail behavior.

Claude-Session: https://claude.ai/code/session_019vpjMJ1e8Sr8roPcYQUDwh
@Laaaaksh
Laaaaksh merged commit 3ad54df into main Aug 30, 2026
0 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant