Skip to content

docs: add public architecture doc, dev.to link, update performance guide#27

Merged
kolkov merged 2 commits intomainfrom
docs/public-architecture-and-links
Mar 2, 2026
Merged

docs: add public architecture doc, dev.to link, update performance guide#27
kolkov merged 2 commits intomainfrom
docs/public-architecture-and-links

Conversation

@kolkov
Copy link
Contributor

@kolkov kolkov commented Mar 2, 2026

Summary

  • Add public docs/ARCHITECTURE.md — comprehensive architecture documentation updated to v0.4.1
  • Add dev.to article link to README.md (badge in header + blockquote + Related Projects)
  • Fix broken link to private docs/dev/TECHNICAL_ARCHITECTURE.md → public docs/ARCHITECTURE.md
  • Update docs/PERFORMANCE.md to v0.4.1: Go 1.26 CGO improvements section, updated purego comparison table
  • Update Related Projects section with ecosystem links (go-webgpu/webgpu, born-ml/born, gogpu)

Details

docs/ARCHITECTURE.md — new public file covering:

  • Four-layer architecture (Go → cgocall → Assembly → C)
  • Calling conventions table (System V, Win64, AAPCS64)
  • Struct return handling (≤8B, 9-16B, >16B)
  • Callback system (crosscall2, trampolines)
  • Type system (TypeDescriptor)
  • Key files reference

docs/PERFORMANCE.md — updated:

  • Version v0.1.0 → v0.4.1
  • CGO overhead updated for Go 1.26 (~30% reduction)
  • New "Go 1.26 CGO Improvements" section
  • purego comparison table expanded (callback float returns, ARM64 HFA, context support)
  • Roadmap updated to current milestones

Test plan

  • Verify all links in README.md resolve correctly
  • Verify docs/ARCHITECTURE.md renders properly on GitHub
  • CI passes (no code changes)

kolkov added 2 commits March 2, 2026 12:37
- Add docs/ARCHITECTURE.md — public architecture documentation (v0.4.1)
- Add dev.to article badge and blockquote link to README.md
- Update Related Projects with ecosystem links (webgpu, born-ml, gogpu)
- Fix broken link: docs/dev/TECHNICAL_ARCHITECTURE.md → docs/ARCHITECTURE.md
- Update docs/PERFORMANCE.md to v0.4.1: Go 1.26 CGO section, purego comparison
@codecov
Copy link

codecov bot commented Mar 2, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@kolkov kolkov merged commit 59233d2 into main Mar 2, 2026
9 checks passed
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