Skip to content

docs: bring the README back in line with the code - #20

Merged
duuyguyiilmaz merged 1 commit into
mainfrom
docs/readme-accuracy
Aug 31, 2026
Merged

duuyguyiilmaz merged 1 commit into
mainfrom
docs/readme-accuracy

Conversation

@duuyguyiilmaz

Copy link
Copy Markdown
Owner

A pass over the claims the last few changes made stale. No screenshots added — the existing ones stay as they are.

What was wrong Now
The leaderboard screenshot caption said it showed the viewer's own department It was captured before the ranking was scoped, so the image is wider than what the app now returns. The caption says so, rather than quietly misdescribing the picture under it.
"Points and rewards — uploaders earn points from ratings" implied a stored balance The total is the score the user's own notes have earned, computed where it is shown
The rating rules read as app behaviour No self-rating and one vote per person are enforced by the security rules, which is the part worth stating in a feature list
Email verification listed as an unresolved gap Now a decision. It is one call away and left open deliberately: the accounts here are test data, and a mandatory confirmation step would put a mailbox between a reviewer and the running app for nothing.
"No pagination" described a state from two changes ago Still true that both read every matching note — but the leaderboard no longer reads the whole collection, and the createdAt normalisation the ordering depends on has landed. The entry now says what is left.
"Deploy the security rules" was a parenthetical A step with the command in it, and a sentence on why it is not only about access: the rules are what verify the scoring, so an un-deployed project is either blocked or cheatable
The rules-tests intro cited points as an example of what only Firestore can enforce That field no longer exists; replaced with the scoring check

Verification

Every in-page anchor resolves to a heading, and every relative link resolves to a file that exists — checked mechanically, not by eye.

🤖 Generated with Claude Code

A pass over the claims the last few changes made stale. No screenshots added; the
existing ones stay as they are.

- The leaderboard screenshot caption said it showed the viewer's own department. It was
  captured before the ranking was scoped, so the image is wider than what the app now
  returns. Saying so is better than a caption that quietly misdescribes the picture
  under it.
- "Points and rewards — uploaders earn points from ratings" implied a stored balance.
  The total is the score the user's own notes have earned, computed where it is shown.
- Rating rules — no self-rating, one vote per person — are now enforced by the security
  rules rather than only by the app, which is the part worth stating in a feature list.
- Email verification moves from a gap to a decision. It is one call away and left open
  deliberately: the accounts here are test data, and a mandatory confirmation step would
  put a mailbox between a reviewer and the running app for nothing.
- The pagination entry said the feed and leaderboard read every matching note and sorted
  in memory. Still true, but the leaderboard no longer reads the whole collection, and
  the createdAt normalisation the ordering depends on has already landed. The entry now
  says what is left rather than what was true two changes ago.
- "Deploy the security rules" was a parenthetical. Now a step with the command in it,
  and a sentence on why it is not only about access: the rules are what verify the
  scoring, so an un-deployed project is either blocked or cheatable.
- The rules-tests intro still cited `points` as an example of what only Firestore can
  enforce, and that field no longer exists.

Verified: every in-page anchor resolves to a heading, and every relative link resolves
to a file that exists.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@duuyguyiilmaz
duuyguyiilmaz merged commit f21dec6 into main Aug 31, 2026
2 checks passed
@duuyguyiilmaz
duuyguyiilmaz deleted the docs/readme-accuracy branch August 31, 2026 15:00
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