docs(readme): hero + architecture images, polish pass#17
Merged
Conversation
- docs/assets/hero.png — phone + terminal side-by-side product demo, between the title and intro paragraph. - docs/assets/architecture.png — five-node data-flow schematic, in a new ## Architecture section after Features (points at docs/architecture/overview.md for the deep dive). docs/assets/ is the new canonical home for repo-tracked visual assets.
README didn't carry the standard warranty disclaimer — only the MIT LICENSE file had it. For a project that intentionally gives a whitelisted Telegram user root on a VPS, surfacing the "at your own risk" posture on the landing page is worth doing. Covers the specific failure modes this software can cause (data loss, VPS compromise, audit-blob secret exposure, whitelist-user actions, account lockout) and the operator responsibilities that follow from them.
Adds the "first-impression polish" every sizeable README expects: - Italic one-line tagline under the title - Badge row: CI, release, CodeQL, Go version, Go Report Card, license - Table of contents (anchor links to every `## ` section) - Quickstart section — 4-command install + /start on Telegram, with link to docs/getting-started/quickstart.md for the full walkthrough - Security section near the bottom — private-advisory flow + email contact, so landing visitors don't open public issues for vulnerabilities - Releases link in the Quickstart block (in addition to the release badge at the top)
Second pass on README polish: - Status blockquote under the badges: "v0.1.x — early, stable for solo-operator use; API may shift before 1.0". - "Why not just SSH?" section after Architecture — 6 bullets naming the concrete differentiators (audit trail, phone-only, danger-matcher, RBAC, live streaming, per- command containment) + "use SSH when…" escape hatch. - Requirements section right before Install: OS + arch matrix, systemd version note (including the 250+ requirement for the optional creds mode), Go version (only for from-source builds), network posture, disk footprint. - Acknowledgments section before Security: creack/pty, go-telegram/bot, GORM + modernc/sqlite, zap, goreleaser + release-please, lefthook + golangci-lint + gitleaks + govulncheck + syft. - TOC updated with the three new sections.
Neither the configuration schema (docs/configuration/schema.md) nor the FAQ (docs/faq.md) were linked from the README. Rather than scatter one-off links, add a single "## Documentation" section with the doc-tree landmarks so landing visitors can find what they need in one scan. Between Development (how to hack on it) and Known limitations (what doesn't work). Includes inline deep-links to the most- requested single pages: configuration/schema.md, all eight reference pages, deployment/production-checklist.md, and the FAQ. TOC updated.
amiwrpremium
added a commit
that referenced
this pull request
Apr 22, 2026
🤖 I have created a release *beep* *boop* --- ## [0.1.3](v0.1.2...v0.1.3) (2026-04-22) ### Documentation * **readme:** hero + architecture images, polish pass ([#17](#17)) ([bc47b83](bc47b83)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
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
1 participant
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.
Overhauls the README for first-impression polish.
Visuals
docs/assets/hero.png) between title and intro.docs/assets/architecture.png) in a new `## Architecture` section.Top-of-page
Navigation
New sections
docs/configuration/schema.md+docs/faq.mdwhich weren't linked before).Commit layout (5 commits, reviewable one at a time)