Skip to content

docs: rewrite the README as the front door, and fit the GitHub templates to an open-source project - #89

Merged
teo-goulois merged 2 commits into
mainfrom
docs/readme-front-door
Nov 9, 2026
Merged

teo-goulois merged 2 commits into
mainfrom
docs/readme-front-door

Conversation

@teo-goulois

Copy link
Copy Markdown
Contributor

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 dev demo, 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

  • Building from source, the repository layout, pnpm tauri:dev, pnpm web:dev and the quality checks move to CONTRIBUTING.md (in the contributor-docs PR).
  • The CLI example and the route, wildcard and static-folder details live in the user guide.

Removed

  • "Design notes for features that are not built yet". Public URLs and remote machines have shipped.
  • The separate Acknowledgements section. The Roxy credit is now in License.

Kept: the telemetry text, as "Privacy", with the same facts.

GitHub templates

  • Bug report: asks how Localify was installed (app, install.sh, source), for the Linux distribution, and for localify status and service output. It also points to the troubleshooting section and to SECURITY.md.
  • Feature request: asks what the person is trying to do.
  • Issue chooser: adds a link to the user guide next to the private security report.
  • PR template: lists the checks by area (Rust, desktop UI with pnpm desktop:test, web, cloud), the changes/ note, and docs.

Deleted files

  • assets/logo-icon-2-white.svg: nothing in the repo references it (rg logo-icon finds nothing on any branch). The README logo uses desktop-ui/public/logo.png.

Checks

  • A link check over all tracked markdown found 0 broken relative links or anchors. It also covered github.com/Synapsr/Localify/blob/main/… links, the anchors the desktop app's onboarding opens, and the three docs PRs merged together.
  • No Rust or desktop-ui change.

…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.
@teo-goulois
teo-goulois merged commit cc20661 into main Nov 9, 2026
4 checks passed
@teo-goulois
teo-goulois deleted the docs/readme-front-door branch November 9, 2026 20:43
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