Repository navigation
Rework the README as a product page and refresh the homepage - #348
Merged
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
README
README.mdis 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.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.srcsetcandidates and image links.AGENTS.md,PARITY.md, one source comment (App/Integration/FolderAccess.swift) andscripts/build-site.py, which now renders both new files as site pages (docs/developing.html,docs/architecture.html).Homepage (
website/index.html)brew install --cask beastry/tap/stowsits under the download buttons in the hero and the closing section.Beastry/brand(final/mark.jpg, cropped and downscaled), plus an Architecture link.theme-colormeta 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.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
DESIGN.mdis left as it is.brew install stowinstalls GNU Stow, so both pages give the full cask name.ARCHITECTURE.md.AGENTS.md; Codex reviewed functional behavior and fixed generated documentation asset URLs.beastry.app/stow/is a separate copy of this site inBeastry/beastry.appand does not pick these changes up.Checks
scripts/build-site.pybuilds the site with all six docs pages. Nine focused URL checks cover local assets, multi-candidatesrcset, external/data URLs and document links. The generated README mascot and both light/dark screenshots load successfully in a browser.scripts/check-localizations.sh zh-Hans: 0 of 1311 strings missing.🤖 Generated with Claude Code