Skip to content

docs: refresh public nano readme - #8

Merged
AkiGarage merged 2 commits into
mainfrom
codex/sync-widget-and-rewrite-readme
Jun 26, 2026
Merged

AkiGarage merged 2 commits into
mainfrom
codex/sync-widget-and-rewrite-readme

Conversation

@AkiGarage

@AkiGarage AkiGarage commented Jun 26, 2026 •

Copy link
Copy Markdown
Owner

Summary

Public Nano refresh that follows the private reconciliation PR and keeps the public repository to the approved macOS release surface.

Depends on private draft PR: AkiGarage/codex-usage-widget#20. Merge this public PR only after the private PR is accepted.

Exact exported product changes

  • Product source and tests were compared against the private Widget branch after Widget-to-Nano name mapping and are behaviorally aligned.
  • No new private implementation files were copied into public.
  • Rewrote README.md and README.ja.md for the current macOS app with latest-release install links instead of hardcoded version install text.
  • Clarified SECURITY.md so it no longer points to a nonexistent README security contact.
  • Preserved public release history and added an Unreleased changelog note for this docs/security refresh.

Excluded private categories

  • Private continuity and handoff docs
  • Development logs and progress logs
  • iOS experiments and plans
  • Sync backend experiments
  • Marketing, Remotion, generated media, and artifacts
  • Local machine paths, credentials, tokens, cookies, and private automation state

Validation results

  • PASS: swift test (30 tests)
  • PASS: TZ=UTC swift test (30 tests)
  • PASS: swift build -Xswiftc -strict-concurrency=complete
  • PASS: ./script/build_and_run.sh --verify
  • PASS: xcrun swift script/verify_resize_cursors.swift
  • PASS: RESIZE_TEST_EXPECT_CURSOR=0 RESIZE_TEST_INSET=4 xcrun swift script/verify_resize_interaction.swift
  • PASS: RESIZE_TEST_EXPECT_CURSOR=1 RESIZE_TEST_INSET=3 xcrun swift script/verify_resize_interaction.swift
  • PASS: codesign --verify --strict --deep dist/CodexUsageNano.app
  • PASS: git diff --check
  • PASS: README local link and image path check
  • PASS: tracked public denylist scan for private paths/names/material
  • PASS: token-like secret regex scan; no secret scanner was installed in PATH, so no external scanner was available
  • PASS: .app bundle scan for private paths, old Widget names, CodexBar binary, credentials, tokens, cookies, and AppleDouble files
  • PASS: git archive scan of proposed public tree: 62 entries, no denylisted paths
  • PASS: normalized private/public comparison: 22 aligned product source/test/script rows; only expected public Nano version metadata differs
  • PASS: window-only visual spot check for collapsed tab and detail panel

Release safety

No PR was merged. No tag was moved or created. No GitHub Release was published or edited.

Summary by CodeRabbit

  • Documentation
    • Refreshed the English and Japanese README files with a clearer structure, updated install steps, improved usage guidance, and revised troubleshooting, privacy, and uninstall sections.
    • Updated links and wording to match the current macOS app download flow.
  • Security
    • Clarified how to report vulnerabilities, including when private reporting is unavailable.

@coderabbitai

coderabbitai Bot commented Jun 26, 2026 •

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e5d72494-d98d-4d02-9b2f-f78d2292b298

📥 Commits

Reviewing files that changed from the base of the PR and between d53278e and 8405515.

📒 Files selected for processing (4)
  • CHANGELOG.md
  • README.ja.md
  • README.md
  • SECURITY.md

📝 Walkthrough

Walkthrough

The English and Japanese README files were rewritten with new preview, install, usage, privacy, troubleshooting, uninstall, and license sections. SECURITY.md now changes the vulnerability reporting process, and CHANGELOG.md adds an unreleased note for the documentation updates.

Changes

Documentation refresh and vulnerability reporting

Layer / File(s) Summary
English README intro and install
README.md
Replaces the opening overview with the new description, preview tables, feature and requirement sections, and release and source installation steps.
English README usage and support
README.md
Replaces the usage, privacy, troubleshooting, uninstall, and license sections with table-based instructions, local snapshot notes, reset steps, and closing links.
Japanese README intro and install
README.ja.md
Replaces the opening overview with the new description, preview tables, feature and requirement sections, and updated installation steps.
Japanese README usage and support
README.ja.md
Replaces the usage, privacy, troubleshooting, uninstall, and license sections with table-based instructions, snapshot notes, reset steps, and closing text.
Vulnerability reporting and changelog
SECURITY.md, CHANGELOG.md
Updates the vulnerability reporting instructions and adds an unreleased changelog entry for the README and security guidance updates.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Poem

A bunny hops through docs so bright,
With previews, steps, and links in sight.
I sniffed the changelog, neat and small,
Then nibbled privacy notes and all.
🐇 The guardrails shine, the pages gleam!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title is clear and matches the main docs refresh across the public Nano README files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/sync-widget-and-rewrite-readme

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@AkiGarage

Copy link
Copy Markdown
Owner Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jun 26, 2026 •

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@AkiGarage
AkiGarage marked this pull request as ready for review June 26, 2026 05:15
@AkiGarage
AkiGarage merged commit 1cf177b into main Jun 26, 2026
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