Skip to content

docs(readme): search-friendly opening - #877

Merged
bong-water-water-bong merged 3 commits into
mainfrom
seo/readme-keywords
Nov 3, 2026
Merged

bong-water-water-bong merged 3 commits into
mainfrom
seo/readme-keywords

Conversation

@bong-water-water-bong

Copy link
Copy Markdown
Collaborator

Part of the owner's SEO pass (site side: 1bit-MONSTER/site#18). README.md only; proposed, not for self-merge.

What changes

line before after
H1 1bit engine: local LLMs on the AMD Ryzen AI MAX+ 395 1bit engine: local LLM inference on AMD Strix Halo (Ryzen AI MAX+ 395)
first paragraph "Boot a USB stick, and your ... machine serves local LLMs on its GPU and NPU, on Linux, through AMD's Lemonade Server. That is the whole setup." opens with "One binary to rule them all", then model-agnostic, Strix Halo / Ryzen AI MAX+ 395, Linux, Radeon 8060S (gfx1151) via HRX + our HIP kernels, XDNA 2 NPU via our NPU runtime, Lemonade Server + OpenAI-compatible API; ends with the same "Boot a USB stick ... That is the whole setup."
## What it is ## What it is: one model-agnostic binary for the GPU and the NPU
## Documentation ## Documentation and measured results

GitHub and search engines use the H1 and the first paragraph as the repository's snippet, so those now carry the terms people search for (Strix Halo, Ryzen AI MAX+ 395, Radeon 8060S, gfx1151, XDNA 2 NPU, Lemonade Server, OpenAI-compatible, local LLM inference).

Kept true

  • Every fact was already in this README ("What it is" and the badges/docs list); nothing new is claimed, and nothing about the release changes (the Milestones row still says v2026.44 is a draft).
  • The Apache header is untouched; no new file, so tools/copyright.py --check is unaffected.
  • No link anchors are lost: nothing in this repo or the site links to #what-it-is or #documentation.

Merge order with #859

#859 rewrites the "Get started" steps (lines 30-33 plus an inserted paragraph). This PR touches lines 17, 25-26, 37 and 55, with unchanged lines between, so the two merge in either order without a conflict.

🤖 Generated with Claude Code

The heading and the first paragraph now carry what people search for:
Strix Halo, Ryzen AI MAX+ 395, Radeon 8060S (gfx1151), XDNA 2 NPU, HRX and
HIP kernels, Lemonade Server, OpenAI-compatible API, model-agnostic, with
"one binary to rule them all" up front. Two headings say what is under them.
Every fact was already in this README; nothing else changed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Nov 3, 2026 •

Copy link
Copy Markdown

PR Reviewer Guide 🔍

(Review updated until commit 441a391)

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

SEO Claim Verification

The PR updates the README to improve search engine visibility by incorporating specific hardware and software terms. However, the PR description claims that "every number in docs, commit messages and the PR body must be measured on the hardware and say how" but does not provide any measured performance or hardware-specific data to back up the SEO improvements or the described hardware capabilities. This is a significant concern as it introduces unverified claims that could mislead users about the actual performance or compatibility of the engine on the specified hardware.

# 1bit engine: local LLM inference on AMD Strix Halo (Ryzen AI MAX+ 395)

[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
[![Lemonade pin: last bump](https://img.shields.io/github/last-commit/1bit-MONSTER/engine?path=third_party%2Flemonade&label=Lemonade%20pin&color=f5c518)](https://github.com/1bit-MONSTER/engine/tree/main/third_party/lemonade)
[![Releases](https://img.shields.io/badge/releases-GitHub-24292f)](https://github.com/1bit-MONSTER/engine/releases)
[![Documentation: 1bit.gg](https://img.shields.io/badge/docs-1bit.gg-1779e1)](https://1bit.gg/)
[![Discord](https://img.shields.io/badge/chat-Discord-5865F2)](https://discord.gg/fa5m4Vawpa)

One binary to rule them all: the 1bit engine is a model-agnostic local LLM inference engine for the
AMD Ryzen AI MAX+ 395 (Strix Halo) on Linux. It serves any GGUF on the Radeon 8060S iGPU (`gfx1151`)
through HRX with our own HIP kernels, and models on the XDNA 2 NPU through our own NPU runtime, as a
backend of AMD's [Lemonade Server](https://github.com/lemonade-sdk/lemonade) and its OpenAI-compatible API.
Boot a USB stick, and the machine serves local LLMs on its GPU and NPU. That is the whole setup.

@bong-water-water-bong bong-water-water-bong left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

VERDICT: READY

At 7c6ec6062. README only, +8/-5, build/CodeQL/Analyze ×4/pr_agent all success at that head.

What I checked, beyond reading it:

The claims are already in the tree, so nothing new is asserted. Every term the new opening promotes is in docs/
already: "Strix Halo" 18 files, "Ryzen AI MAX+ 395" 3, "Radeon 8060S" 3, "gfx1151" 3, "XDNA 2" 4, "OpenAI-compatible" 5.
The four hunks touch the H1, the first paragraph, one ## heading and one ## heading — nothing else; the Milestones row
("v2026.44 is a draft") and the Apache header are untouched.

README.md is the source of 1bit.gg/overview.html, so I built the site against this README and against main's, which is
the consequence a README SEO change actually has:

ONEBIT_ENGINE_DIR=<engine at pr877> python3 tools/site.py <out>   -> 53 pages, rc 0   (same as main's README)
render diff of overview.html: the H1, the first paragraph, and the two <h2>s — nothing else
<title> and <meta description> unchanged ("What the 1bit engine is and what runs where · 1bit engine")
one <h1> per page still holds (the site's own build check)
JSON-LD TechArticle.headline follows the H1 automatically -> "…local LLM inference on AMD Strix Halo (Ryzen AI MAX+ 395)"

Anchors. Nothing in this repo or in the site repo links to #what-it-is or #documentation (grep over *.md,
*.html, *.py, *.json), so the two headings can be renamed. Both anchors do change, though —
#what-it-is-one-model-agnostic-binary-for-the-gpu-and-the-npu, #documentation-and-measured-results — on GitHub and on
overview.html. That is the one cost this PR carries that it does not mention: any inbound link from outside the repo (a
Discord message, an already-indexed snippet, someone's bookmark) lands at the top of the page instead of the section. Not a
blocker, and unavoidable if the headings are to carry the terms, but worth one sentence in the body.

Merge order with #859: verified rather than assumed — git merge-tree pr877 pr859 returns rc 0, no conflict, which
matches the body's claim about the untouched lines between the two PRs.

Two nits, neither blocking:

  1. "One binary to rule them all" now opens the first paragraph and the "What it is" paragraph about ten lines below, so a
    reader sees the same sentence twice in the top fold on GitHub and on the overview page. The first paragraph could keep
    the search terms and lose the slogan, since the h2 below now repeats it.
  2. The PR body ends with a "🤖 Generated with [Claude Code]" trailer. Public repo, so it is worth dropping from these.

@bong-water-water-bong bong-water-water-bong added the tprs-ready TPRS: review verdict READY posted by the standing reviewer; merge gate satisfied label Nov 3, 2026
@github-actions

github-actions Bot commented Nov 3, 2026

Copy link
Copy Markdown

Persistent review updated to latest commit 36d88f4

@bong-water-water-bong bong-water-water-bong left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

VERDICT: READY

At 36d88f4e4 (merge of eec6d2231 into 7c6ec6062), superseding my line at 7c6ec6062. README.md is
blob-identical at both heads, so the update added nothing and the review below it stands unchanged.

Evidence recap, since this one is about SEO and the evidence is not obvious from the diff: every promoted term already
appears in docs/ (Strix Halo 18 files, Ryzen AI MAX+ 395 3, Radeon 8060S 3, gfx1151 3, XDNA 2 4, OpenAI-compatible 5);
README.md is the source of 1bit.gg/overview.html and I built the site against this README (53 pages, rc 0, one <h1>,
<title>/description unchanged because they come from PAGE_META, JSON-LD headline following the new H1); nothing in the
repo or the site links to #what-it-is/#documentation; and merge-tree pr877 pr859 is clean.

CI at 36d88f4e4: build success (03:21Z), CodeQL/Analyze x4/pr_agent success.

@github-actions

github-actions Bot commented Nov 3, 2026

Copy link
Copy Markdown

Persistent review updated to latest commit 441a391

@bong-water-water-bong bong-water-water-bong left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

VERDICT: READY

At 441a391d4 (merge of aa6db8ded into 36d88f4e4), superseding my line at 36d88f4e4. README.md is
blob-identical (243fcbe24934… at both heads), so the merge added no author change and the review stands: the promoted
terms all already exist in docs/, README.md is the source of 1bit.gg/overview.html (built both ways — 53 pages rc 0, one
<h1>, <title>/description unchanged), nothing links to the two renamed anchors, and merge-tree pr877 pr859 is clean.

CI at 441a391d4: build success (03:30Z).

@bong-water-water-bong
bong-water-water-bong merged commit 23d6972 into main Nov 3, 2026
8 checks passed
@bong-water-water-bong
bong-water-water-bong deleted the seo/readme-keywords branch November 3, 2026 03:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Review effort 1/5 tprs-ready TPRS: review verdict READY posted by the standing reviewer; merge gate satisfied

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant