Skip to content

Rework the README as a product page and refresh the homepage - #348

Merged
skyswordw merged 2 commits into
mainfrom
claude/readme-homepage-refresh
Nov 11, 2026
Merged

skyswordw merged 2 commits into
mainfrom
claude/readme-homepage-refresh

Conversation

@skyswordw

@skyswordw skyswordw commented Nov 11, 2026 •

Copy link
Copy Markdown
Member

What changed

README

  • README.md is now a product page: mascot, screenshot, install (DMG and Homebrew), what Stow does, formats, privacy, build steps, a documentation table, and a "part of Beastry" footer.
  • The developer material moved, text intact, into two new files:
    • DEVELOPING.md: requirements, build, tests, design-review screenshots, fixtures, settings keys, source layout.
    • ARCHITECTURE.md: archive engine, Finder / Quick Look / Services, the hand-off, sandbox decisions, installing, Extract commands, first run and Settings, updates, new archives and the sample.
  • The site builder keeps README image URLs on the site, including light/dark srcset candidates and image links.
  • Pointers updated in AGENTS.md, PARITY.md, one source comment (App/Integration/FolderAccess.swift) and scripts/build-site.py, which now renders both new files as site pages (docs/developing.html, docs/architecture.html).

Homepage (website/index.html)

  • The nav's primary button is Download (latest release); GitHub becomes a plain link.
  • A copyable brew install --cask beastry/tap/stow sits under the download buttons in the hero and the closing section.
  • Removed the stale "A full video comes with the first signed release" line; hero and closing meta lines now state requirements.
  • Neutrals lean toward Beastry's Cream and Charcoal in light and dark; Stow's amber accent is unchanged. The docs page template uses the same values.
  • Footer: "Part of Beastry" with the approved mark from Beastry/brand (final/mark.jpg, cropped and downscaled), plus an Architecture link.
  • Open Graph and theme-color meta tags.

Mascot

  • website/assets/mascot.svg: a squirrel peeking over the parcel from the app icon, with the same tape. beastry.app already lists Stow under a placeholder squirrel. It is used in the README header and the homepage's closing section.
  • The app icon, nav logo and favicon are unchanged (still Design/AppIcon.svg).

Why

The README opened with build internals, called Stow a prototype and said the name was a working name, although signed, notarized releases ship through 0.1.7 with a Homebrew cask. The homepage's main action led to the repository rather than the download. The Beastry guidelines ask product pages to lead with the product's own visuals and place the mother brand in a secondary position, which is what the footer does.

For reviewers

  • Name. "Stow is a working name" is removed from the README. The trademark note in DESIGN.md is left as it is. brew install stow installs GNU Stow, so both pages give the full cask name.
  • Mascot status. It is drawn with the kit proposed in Logo review: vector master, small-size cut, and a shared construction for product marks brand#2, which is under review. Treat it as a first version; if that proposal changes, this file follows.
  • Moved text. Sections were moved, not rewritten. The only edits are headings for paragraphs that had none (Extract commands, First run and Settings, Updates, New archives and the sample) and three new rows in the layout table.
  • Functional contracts. No app behavior changes. The single Swift change is a comment that now points to ARCHITECTURE.md.
  • Ownership. Visual design by Claude Code, per AGENTS.md; Codex reviewed functional behavior and fixed generated documentation asset URLs.
  • beastry.app/stow/ is a separate copy of this site in Beastry/beastry.app and does not pick these changes up.

Checks

  • scripts/build-site.py builds the site with all six docs pages. Nine focused URL checks cover local assets, multi-candidate srcset, external/data URLs and document links. The generated README mascot and both light/dark screenshots load successfully in a browser.
  • Homepage checked in the browser in light, dark and at 375 px: no console errors, no horizontal scroll, mascot and Beastry mark load.
  • scripts/check-localizations.sh zh-Hans: 0 of 1311 strings missing.
  • The Xcode test suite was not run; the only source change is a comment.

🤖 Generated with Claude Code

skyswordw and others added 2 commits November 10, 2026 17:12
The README opened with build internals and still called Stow a prototype
with a working name, although signed releases ship through 0.1.7.

- README.md is now a product page: install (DMG and the full Homebrew
  cask name), what Stow does, formats, privacy, build steps and a
  documentation table, with Beastry in the footer.
- The developer material moves unchanged into DEVELOPING.md (build, tests,
  snapshot scenes, settings keys, layout) and ARCHITECTURE.md (engine,
  Finder, sandbox, installing, updates). AGENTS.md, PARITY.md, one source
  comment and the site build now point there; both render as site pages.
- Homepage: Download is the nav's primary action, a copyable Homebrew
  command sits under the download buttons, the stale 'first signed
  release' line is gone, neutrals lean toward Beastry's Cream and
  Charcoal, and the footer says Part of Beastry with the approved mark.
- Adds a mascot (website/assets/mascot.svg): a squirrel behind the parcel
  from the app icon. The app icon, nav logo and favicon are unchanged.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@skyswordw
skyswordw merged commit 89d9158 into main Nov 11, 2026
3 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