Skip to content

[codex] Update README for scrolling capture and screenshot history#44

Merged
lzhgus merged 2 commits intomainfrom
codex/readme-scroll-history
Apr 14, 2026
Merged

[codex] Update README for scrolling capture and screenshot history#44
lzhgus merged 2 commits intomainfrom
codex/readme-scroll-history

Conversation

@lzhgus
Copy link
Copy Markdown
Owner

@lzhgus lzhgus commented Apr 14, 2026

Summary

This PR updates the README to reflect two features that are already shipped:

  • scrolling capture
  • screenshot history

It also fixes the architecture section so the documented module layout matches the current app structure.

What changed

  • added Scrolling capture to the screenshot feature list
  • added a new Screenshot History section describing the shipped history window
  • removed scrolling capture and screenshot history from the roadmap
  • updated the architecture section from 8 packages to 9 packages
  • added History/ and HistoryKit/ to the architecture tree
  • synced the same updates in both:
    • README.md
    • README.zh-CN.md

Why it changed

The README still described these features as future roadmap items, which no longer matched the product.

Impact

  • users browsing the repo now see the current feature set more accurately
  • English and Simplified Chinese documentation stay in sync
  • the architecture section now reflects the actual history modules in the app

Validation

  • reviewed the README diff for both language variants

Notes

This is a docs-only PR. No app code was changed.

lzhgus added 2 commits April 13, 2026 22:21
The README still listed scrolling capture and screenshot history as roadmap
items even though both features are now shipped. This update moves them into
the feature list, syncs the English and Simplified Chinese docs, and fixes the
architecture section to include the history modules that now exist in the app.

Constraint: Public README copy must stay aligned across English and Simplified Chinese variants
Constraint: This is a docs-only update, so feature descriptions should match shipped behavior without over-promising implementation details
Rejected: Update only README.md | would leave the Chinese README stale and contradictory
Rejected: Add new comparison-table claims for history/scrolling features | competitor support is less certain than Capso's current implementation
Confidence: high
Scope-risk: narrow
Reversibility: clean
Directive: When a roadmap item ships, remove it from both README variants and reflect it in the feature/architecture sections together
Tested: README.md and README.zh-CN.md diff review
Not-tested: Rendered markdown preview on GitHub
Capso already ships Japanese and Korean in the app, but the repository only
surfaced English and Simplified Chinese README variants. This adds Japanese and
Korean README files and updates the language switcher so all four versions link
to each other.

Constraint: The four README variants should describe the same shipped feature set and navigation structure
Constraint: This remains a docs-only update, so translations should favor clarity and parity over introducing new claims
Rejected: Keep Japanese and Korean support implied only in the feature list | does not help users who expect a localized landing README
Rejected: Add placeholder one-paragraph README files | inconsistent quality versus the existing English/Chinese docs
Confidence: medium
Scope-risk: narrow
Reversibility: clean
Directive: When adding new README translations, update every README's language switcher together to avoid orphaned docs
Tested: README.md / README.zh-CN.md / README.ja.md / README.ko.md diff review
Not-tested: Native-speaker proofreading for Japanese and Korean wording; rendered GitHub markdown preview
Related: PR #44
@lzhgus lzhgus marked this pull request as ready for review April 14, 2026 05:30
@lzhgus lzhgus merged commit 4bc4b79 into main Apr 14, 2026
5 checks passed
@lzhgus lzhgus deleted the codex/readme-scroll-history branch April 14, 2026 05:30
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