Skip to content

Show GitHub stars in API reference header - #94

Merged
SandroMaglione merged 1 commit into
mainfrom
codex/docs-github-stars
Aug 12, 2026
Merged

Show GitHub stars in API reference header#94
SandroMaglione merged 1 commit into
mainfrom
codex/docs-github-stars

Conversation

@SandroMaglione

@SandroMaglione SandroMaglione commented Aug 12, 2026

Copy link
Copy Markdown
Member

Summary

  • point the API reference header at the repository root instead of an immutable commit subtree
  • preserve revision-specific source links through separate repository and source metadata
  • display a progressively loaded GitHub star count without a third-party badge service
  • cache the public GitHub API response for the browser session and degrade to the normal repository link

Changeset

  • Added or updated for a library or package-metadata change
  • Not required because this PR does not change src/ or package.json

Validation

  • pnpm check
  • Relevant example checks, when examples changed
  • Reviewed the automated type-performance report, when the public TypeScript API or inference changed
  • Reviewed the automated runtime-performance report, when runtime behavior changed

@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Type performance

Measured with TypeScript 6.0.3 and skipLibCheck=true.

Scenario Base PR Difference
Effect only 55 55 0 (0.0%)
Import effect-machine 55 55 0 (0.0%)
Machine.defineStates (3 states) 2,965 2,965 0 (0.0%)
Machine.make (3 states, 2 events) 8,715 8,715 0 (0.0%)
machine.handle (3 states, 2 transitions) 23,492 23,492 0 (0.0%)
machine.handle (depth 8) 117,075 117,075 0 (0.0%)
machine.handle (depth 12) 129,713 129,713 0 (0.0%)
machine.handle (depth 16) 145,055 145,055 0 (0.0%)
machine.handle (depth 24) 183,851 183,851 0 (0.0%)
machine.handle (wide depth 16) 214,189 214,189 0 (0.0%)
machine.handle (parallel/history/choice) 132,667 132,667 0 (0.0%)
machine.handle (4 successive calls) 128,674 128,674 0 (0.0%)
machine exact input/output/error/services 110,584 110,584 0 (0.0%)
execution adapter readiness 127,854 127,854 0 (0.0%)

Marginal instantiations are measured against the matching setup without that API call:

Scenario Base PR Difference
Import effect-machine 0 0 0
Machine.defineStates (3 states) 2,910 2,910 0 (0.0%)
Machine.make (3 states, 2 events) 5,742 5,742 0 (0.0%)
machine.handle (3 states, 2 transitions) 14,777 14,777 0 (0.0%)
machine.handle (depth 8) 109,601 109,601 0 (0.0%)
machine.handle (depth 12) 121,039 121,039 0 (0.0%)
machine.handle (depth 16) 135,181 135,181 0 (0.0%)
machine.handle (depth 24) 171,577 171,577 0 (0.0%)
machine.handle (wide depth 16) 202,224 202,224 0 (0.0%)
machine.handle (parallel/history/choice) 114,331 114,331 0 (0.0%)
machine.handle (4 successive calls) 113,703 113,703 0 (0.0%)
machine exact input/output/error/services 100,670 100,670 0 (0.0%)
execution adapter readiness 102,092 102,092 0 (0.0%)
Check times (informational)
Scenario Base PR
Effect only 0.03s 0.03s
Import effect-machine 0.03s 0.03s
Machine.defineStates (3 states) 0.10s 0.10s
Machine.make (3 states, 2 events) 0.16s 0.16s
machine.handle (3 states, 2 transitions) 0.23s 0.26s
machine.handle (depth 8) 0.52s 0.52s
machine.handle (depth 12) 0.57s 0.56s
machine.handle (depth 16) 0.60s 0.62s
machine.handle (depth 24) 0.70s 0.70s
machine.handle (wide depth 16) 0.78s 0.75s
machine.handle (parallel/history/choice) 0.62s 0.64s
machine.handle (4 successive calls) 0.60s 0.56s
machine exact input/output/error/services 0.51s 0.52s
execution adapter readiness 0.58s 0.60s

Type instantiations are the comparison metric. Check time varies with runner load and is informational only.

@SandroMaglione
SandroMaglione merged commit 7b8fe32 into main Aug 12, 2026
9 checks passed
@SandroMaglione
SandroMaglione deleted the codex/docs-github-stars branch August 12, 2026 04:05
@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Runtime performance

Median of 5 independent benchmark processes on AMD EPYC 7763 64-Core Processor with Node v24.19.0.

Pull request baseline

Scenario Effect Machine XState 5 XState 6 alpha
Plan counter transitions 133,555 transitions/s 133,421 transitions/s 13,286 transitions/s
Drain burst with terminal fence 520,964 increments/s 388,847 increments/s 192,848 increments/s
Drain burst with a change observer 475,578 increments/s 386,935 increments/s 191,194 increments/s
Lookup and send to one child 407,065 increments/s 383,998 increments/s 184,237 increments/s
Start and stop a machine 168,606 machines/s 187,231 machines/s 144,655 machines/s
Start and stop a parent with one child 32,715 families/s 68,362 families/s 41,537 families/s
Plan transitions through a compound state 118,230 transitions/s — —
Plan transitions through parallel regions 90,473 transitions/s — —
Drain burst through a compound state 500,385 events/s 342,283 events/s 186,776 events/s
Drain burst through two parallel regions 460,493 events/s 260,776 events/s 140,175 events/s
Drain a compound-state burst with a change observer 458,293 events/s — —

Effect runtime reference points

Scenario Effect Machine Effect runtime primitives
Start and stop a raw generic process 16,520 processes/s —
Start and stop a raw compiled process 67,259 processes/s —
Start and interrupt a suspended fiber — 165,810 fibers/s
Start and stop a queue worker — 116,333 workers/s
Start and stop an actor shell — 106,417 actors/s
Start and stop two actor shells — 62,617 families/s
Update an owner-only mutable snapshot — 316,856,781 updates/s
Update a synchronized snapshot — 1,523,738 updates/s
Create, resolve, and await a terminal latch — 1,407,634 latches/s
Memory profile Effect Machine XState 5 XState 6 alpha Effect runtime primitives
Idle machine 1.5 KiB 3.8 KiB 2.2 KiB —
Raw generic managed process 12.7 KiB — — —
Raw compiled process 2.8 KiB — — —
Two independent idle machines 3.0 KiB 7.3 KiB 3.9 KiB —
Idle parent with one child 4.8 KiB 5.5 KiB 4.0 KiB —
Parent with observed child registry 9.0 KiB — — —
Parent with observed invoked child snapshots 5.0 KiB — — —
Suspended Effect fiber — — — 0.6 KiB
Effect queue with waiting fiber — — — 2.8 KiB
Effect mailbox actor shell — — — 3.2 KiB
Two Effect actor shells — — — 6.8 KiB

Effect Machine change from base

Metric Base Base variability PR PR variability Difference
Plan counter transitions 132,176 transitions/s 1.4% MAD 133,555 transitions/s 0.6% MAD +1.0%
Drain burst with terminal fence 509,080 increments/s 3.1% MAD 520,964 increments/s 0.9% MAD +2.3%
Drain burst with a change observer 466,073 increments/s 2.3% MAD 475,578 increments/s 0.4% MAD +2.0%
Lookup and send to one child 400,370 increments/s 1.1% MAD 407,065 increments/s 0.5% MAD +1.7%
Start and stop a machine 168,322 machines/s 1.5% MAD 168,606 machines/s 1.4% MAD +0.2%
Start and stop a parent with one child 32,963 families/s 6.5% MAD 32,715 families/s 0.6% MAD -0.8%
Plan transitions through a compound state 119,246 transitions/s 0.2% MAD 118,230 transitions/s 1.0% MAD -0.9%
Plan transitions through parallel regions 91,321 transitions/s 1.2% MAD 90,473 transitions/s 1.1% MAD -0.9%
Drain burst through a compound state 496,856 events/s 0.7% MAD 500,385 events/s 0.6% MAD +0.7%
Drain burst through two parallel regions 456,857 events/s 1.3% MAD 460,493 events/s 0.4% MAD +0.8%
Drain a compound-state burst with a change observer 451,396 events/s 0.7% MAD 458,293 events/s 0.3% MAD +1.5%
Idle machine heap per unit 1.5 KiB 0.3% MAD 1.5 KiB 0.0% MAD -0.3%
Raw generic managed process heap per unit 12.7 KiB 0.0% MAD 12.7 KiB 0.0% MAD -0.0%
Raw compiled process heap per unit 2.8 KiB 0.2% MAD 2.8 KiB 0.3% MAD -0.1%
Two independent idle machines heap per unit 3.0 KiB 0.0% MAD 3.0 KiB 0.0% MAD +0.0%
Idle parent with one child heap per unit 4.8 KiB 0.0% MAD 4.8 KiB 0.0% MAD +0.0%
Parent with observed child registry heap per unit 9.0 KiB 0.0% MAD 9.0 KiB 0.0% MAD -0.0%
Parent with observed invoked child snapshots heap per unit 5.0 KiB 0.1% MAD 5.0 KiB 0.0% MAD +0.3%

Effect runtime reference change from base

Metric Base Base variability PR PR variability Difference
Start and stop a raw generic process 16,309 processes/s 1.8% MAD 16,520 processes/s 1.6% MAD +1.3%
Start and stop a raw compiled process 66,498 processes/s 0.7% MAD 67,259 processes/s 0.8% MAD +1.1%
Start and interrupt a suspended fiber 164,447 fibers/s 1.8% MAD 165,810 fibers/s 0.3% MAD +0.8%
Start and stop a queue worker 115,929 workers/s 1.1% MAD 116,333 workers/s 0.9% MAD +0.3%
Start and stop an actor shell 107,446 actors/s 0.2% MAD 106,417 actors/s 1.3% MAD -1.0%
Start and stop two actor shells 65,454 families/s 1.9% MAD 62,617 families/s 4.5% MAD -4.3%
Update an owner-only mutable snapshot 316,856,781 updates/s 0.0% MAD 316,856,781 updates/s 0.0% MAD 0.0%
Update a synchronized snapshot 1,537,066 updates/s 0.6% MAD 1,523,738 updates/s 1.3% MAD -0.9%
Create, resolve, and await a terminal latch 1,423,897 latches/s 0.8% MAD 1,407,634 latches/s 1.2% MAD -1.1%
Versions and interpretation
  • Effect Machine: 0.5.1
  • XState 5: 5.32.5
  • XState 6 alpha: 6.0.0-alpha.31
  • Effect runtime primitives: 4.0.0-beta.107

Higher throughput is better; lower heap is better. Variability is the median absolute deviation across independent processes, relative to their median. Runtime measurements on shared GitHub-hosted hardware remain informational, so small differences should be confirmed across multiple workflow runs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@SandroMaglione