Skip to content

docs: clarify the README and getting started - #73

Merged
MrScripty merged 1 commit into
mainfrom
docs/readme-clarity-20261015
Oct 21, 2026
Merged

MrScripty merged 1 commit into
mainfrom
docs/readme-clarity-20261015

Conversation

@MrScripty

Copy link
Copy Markdown
Owner

Summary

  • Lead with sharing one local model library across applications.
  • Put supported desktop and headless source routes first, including their native build prerequisites.
  • Link maintained API and operational guidance while preserving ownership, runtime and platform limits.
  • Retain the existing branding banner; this change does not add a UI screenshot.

Verification

  • Revalidated current main and checked command entry points and relative links against source.
  • Independently reviewed the final README and visually inspected the retained banner.
  • Runtime commands were not executed for this documentation-only edit.

@coderabbitai

coderabbitai Bot commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: c9939b5c-c40d-43d0-a819-73acd578db62
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Copy link
Copy Markdown
Owner Author

Disposition review of exact head 76beff227125de77ea32f0a6144d7d736dd3ebab against current main 9ea60b70871bce51a82808cb9d27144e3e62216c: ready for a normal merge. Live inventory contains only this PR, with no dependent open PRs.

The full diff changes README.md only. A separate GPT-6.1 Sol High reviewer independently checked the rewrite against source and maintained guides and found no merge blockers. This is independent Codex documentation review, not a human GitHub approval; the earlier draft-skipped CodeRabbit comment is not counted as source review.

Validation: all 13 relative link targets and the setup anchor resolve; Node/Rust/pnpm pins match; launcher and backend commands, feature selection, loopback restriction, library ownership/root layout, experimental bindings, and narrower platform qualification match source. ./launcher.sh --help, bash -n launcher.sh, dependency-ownership and release-version checks pass. Exact-head Build run 38787974764 succeeded, including all 10 active jobs; tag-only release/package jobs were skipped.

Nonblocking review notes: git diff --check reports one extra blank line at README EOF. The shortened integration section condenses advanced download-root contention guidance; the original paragraph remains at the reviewed main README, and the public error/source contract remains unchanged. No documentation-only claim here qualifies runtime/inference/native UI/trained-model/hardware or release acceptance.

Repository CONTRIBUTING, Development, Architecture, binding and release guidance were read; no repository AGENTS.md exists. The external standards directory named by CONTRIBUTING is absent in this environment, so no independent assertion of external-standards compliance is made. The unchanged image redirects, but the reviewer could not retrieve its final hosted destination here. Existing owner work, branches, commits, CI evidence and scientific campaigns are preserved.

@MrScripty
MrScripty marked this pull request as ready for review October 21, 2026 21:00
@MrScripty
MrScripty merged commit 1dce6dd into main Oct 21, 2026
28 checks passed
@greptile-apps

greptile-apps Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

RetriggerView in GreptileConfidence Score: 4/5

[Low impact] The change reaches readers of the project guide, not running applications.

The documentation change appears safe to merge, with a non-blocking correction needed for Linux build prerequisites.

Findings

  1. P2 Linux prerequisites miss OpenSSL ▶

Summary

The README now leads with sharing one model library and gives shorter desktop, backend, and integration instructions.

  • The README shows how to start the desktop app, run the backend, or integrate it.

Reviews (1) · Last reviewed commit: "docs: make the README clearer and easier..." · Reviewed by Greptile

Comment thread README.md
## Standalone Backend

Build and run without Node, Corepack, frontend assets or Electron:
Use Rust 1.92.0, CMake and your platform's C/C++ build tools. No Node, frontend assets or Electron are needed:

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Linux prerequisites miss OpenSSL

The new prerequisite lists here and in the desktop section omit pkg-config and OpenSSL development headers. pumas-rpc uses reqwest with native TLS enabled, which needs system OpenSSL even with --no-default-features. If a Linux machine has only the listed tools, the build can fail. Add these packages to both source routes—for example, pkg-config and libssl-dev on Debian/Ubuntu.

Copy link
Copy Markdown
Owner Author

Final disposition: merged with a normal merge commit 1dce6dd1e422cb7348779576e5a43ac07c265d7e, retaining both original parents and the source branch.

Post-merge CI on that exact merge SHA is complete and successful:

Final direct open-PR inventory is empty. Existing integration-owner work was left untouched. The documentation review and its nonblocking notes remain the scope of acceptance. No scientific campaign was rerun; skipped inference/release jobs and generic source CI do not extend trained-model, native UI, hardware, runtime-support or release qualification. No unresolved PR-disposition blocker remains.

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