Skip to content

feat: rebrand to BoardVault + documentation + in-app Help/About#20

Merged
github-actions[bot] merged 1 commit into
mainfrom
feat/brand-boardvault-docs
Jun 28, 2026
Merged

feat: rebrand to BoardVault + documentation + in-app Help/About#20
github-actions[bot] merged 1 commit into
mainfrom
feat/brand-boardvault-docs

Conversation

@subkoks

@subkoks subkoks commented Jun 28, 2026

Copy link
Copy Markdown
Owner

Summary

Turn the working-title app into a real product, BoardVault, with proper docs and in-app help.

Brand

  • Display name, app bundle, and .dmgBoardVault (com.subkoks.boardvault); tagline "Apple board schematics". GUI version → 2.0.0.
  • GitHub slug stays apple-all-schematic (stars/links/SEO preserved); description, topics, and homepage rebranded.
  • Legacy migration (paths.migrate_legacy()): copies the pre-rebrand Telegram session + settings to the new data dir, so existing users aren't forced to re-log-in or lose preferences.

In-app

  • New Settings → About & Help tab: version, step-by-step instructions, links (repo, issues, my.telegram.org, license), credits, and a legal/usage note.
  • Polish: the Live-progress scroll viewport is now themed (no white box on dark).

Docs

  • README fully rewritten around BoardVault (app and CLI, install + Gatekeeper note, usage, build-from-source, troubleshooting, legal). Includes dark/light screenshots.
  • docs/USER_GUIDE.md, GUI section in docs/architecture.md, ADR 0001-brand-and-packaging, CHANGELOG 2.0.0, CLAUDE.md overview.

Verification

  • ruff check src/gui clean; pytest 60 passed (same 6 pre-existing failures as main).
  • Isolated headless smoke (patched paths — does not touch real settings): brand constants, legacy migration copies session+settings, window title = BoardVault, 5 settings tabs incl. About & Help.
  • Screenshots regenerated; repo metadata confirmed via gh repo view.
  • .dmg rebuilds as dist/BoardVault.dmg (built & verified separately).

Note

Also fixed a regression from earlier dev testing: a smoke test had written a channel override into the real settings file (macOS QStandardPaths ignores $HOME), which had collapsed the channel list to one entry. Cleared; all 12 defaults restored, and the test isolation is fixed.

🤖 Generated with Claude Code

- brand: rename display name/app/.dmg/bundle-id to BoardVault (com.subkoks.boardvault);
  repo slug and Python distribution name unchanged. Bump GUI version to 2.0.0.
- migration: paths.migrate_legacy() copies the pre-rebrand session/settings so existing
  users keep their Telegram login and preferences.
- settings: new "About & Help" tab (version, instructions, links, credits, legal note).
- docs: full README rewrite around BoardVault (app + CLI, install, usage, build, legal);
  docs/USER_GUIDE.md; GUI section in architecture.md; ADR 0001 (brand + unsigned dmg);
  CHANGELOG 2.0.0; dark/light screenshots; CLAUDE.md overview.
- polish: theme the Live-progress scroll viewport (no white box on dark).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@github-actions
github-actions Bot enabled auto-merge (squash) June 28, 2026 20:48
@github-actions
github-actions Bot merged commit a6bb259 into main Jun 28, 2026
3 checks passed
@subkoks
subkoks deleted the feat/brand-boardvault-docs branch June 28, 2026 21:05
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