Repository navigation
docs: rewrite the README as the front door, and fit the GitHub templates to an open-source project - #89
Merged
Conversation
…tes to an open-source project The README now says what Localify is, shows localify dev, and covers install, the commands people use, coding agents, Localify Cloud, privacy, contributing and the license. Build instructions and the repository layout move to CONTRIBUTING.md. Removes assets/logo-icon-2-white.svg, which nothing references.
This was referenced Nov 9, 2026
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.
The README becomes the front door for people arriving from the open-source launch, and the issue and PR templates fit an open-source project. One of three docs PRs; they touch different files and can merge in any order.
README.md
Rewritten and shorter (126 lines, was 193): what Localify is, a
localify devdemo, install (macOS app and DMG,curl … | sh, link to docs/linux.md), the five commands people use, coding agents and MCP, Localify Cloud in a short paragraph, privacy, contributing, license. Every command and flag was checked against the 1.6.0--help.Moved
pnpm tauri:dev,pnpm web:devand the quality checks move to CONTRIBUTING.md (in the contributor-docs PR).Removed
Kept: the telemetry text, as "Privacy", with the same facts.
GitHub templates
install.sh, source), for the Linux distribution, and forlocalify statusand service output. It also points to the troubleshooting section and to SECURITY.md.pnpm desktop:test, web, cloud), thechanges/note, and docs.Deleted files
assets/logo-icon-2-white.svg: nothing in the repo references it (rg logo-iconfinds nothing on any branch). The README logo usesdesktop-ui/public/logo.png.Checks
github.com/Synapsr/Localify/blob/main/…links, the anchors the desktop app's onboarding opens, and the three docs PRs merged together.