docs: report both benchmark machines in the README and drop the manual URL #482

Merged

natsukium merged 1 commit from docs/readme-performance into main 2026-09-26 12:19:33 +09:00

Conversation 0 Commits 1 Files changed 1 +23 -15

natsukium commented 2026-09-26 10:59:37 +09:00

Owner

Copy link

• Performance: the table and prose now cover both published runs (macOS M4 Max and Linux i5-12400F + RTX 3080), with the best other terminal per metric on each. The prose states where felis leads and where it trails (foot on Linux scrolling, latency, startup, memory), and the macOS ties and overlaps. Every figure is copied from docs/reference/benchmarks.md at main.
• The "What felis owns" bullet drops "class-leading throughput, low keystroke latency, ~50 MB" (true only for the macOS run) and points at the section.
• Drops the felis-docs.pages.dev link, which is not published yet; the README points at docs/ only.

- **Performance:** the table and prose now cover both published runs (macOS M4 Max and Linux i5-12400F + RTX 3080), with the best other terminal per metric on each. The prose states where felis leads and where it trails (foot on Linux scrolling, latency, startup, memory), and the macOS ties and overlaps. Every figure is copied from `docs/reference/benchmarks.md` at `main`. - The "What felis owns" bullet drops "class-leading throughput, low keystroke latency, ~50 MB" (true only for the macOS run) and points at the section. - Drops the `felis-docs.pages.dev` link, which is not published yet; the README points at `docs/` only.

natsukium added 1 commit 2026-09-26 10:59:37 +09:00

docs: report both benchmark machines in the README and drop the manual URL ... 78da93372d

The README's performance section quoted only the macOS run, and its
feature list called the result class-leading with low latency and a
50 MB footprint, while the published Linux run has foot ahead on
scrolling, latency, startup and memory. The section now puts both
machines side by side with the rows where felis leads and trails, and
leaves spreads and conditions to the benchmarks page.

The manual site the README pointed to is not published yet, so the
README now points only at docs/.

Assisted-by: Claude Code

natsukium merged commit 1349bfc9b7 into main 2026-09-26 12:19:33 +09:00

natsukium deleted branch docs/readme-performance 2026-09-26 12:19:33 +09:00

natsukium referenced this pull request from a commit 2026-09-26 12:19:33 +09:00

docs: report both benchmark machines in the README and drop the manual URL (#482)

Commenting is not possible because the repository is archived.

Reviewers

No reviewers

Labels

Clear labels   

priority/P0

Must be resolved before the v0.1.0 tag

  

priority/P1

Must be settled before the first public contract freezes

  

priority/P2

Explicitly deferred until after v0.1.0

  

release/v0.1.0

Work tracked for the first tagged release

  

status/blocked

Cannot start now: waits on an upstream release, another issue, or a recorded revisit trigger

  

status/planned

Triaged with a source-grounded plan and a passed pi review; ready to implement

  

type/bug

Shipped behavior that contradicts the docs or the code's own intent; needs a product code change

  

type/design

An open scope or trade-off question; needs a recorded decision in the owning explanation doc before code

  

type/test-gap

Documented or reviewed behavior that no test pins; usually split from a review finding, needs no product code change

  

type/tracker

Parent issue that tracks child work

No labels

priority/P0

priority/P1

priority/P2

release/v0.1.0

status/blocked

status/planned

type/bug

type/design

type/test-gap

type/tracker

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

natsukium/felis!482

No description provided.