vlang/vsl

docs: add compute module README

Open

#324 opened on Jul 14, 2026

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)V (49 forks)auto 404
Hacktoberfestdocumentationgood first issue

Repository metrics

Stars
 (400 stars)
PR merge metrics
 (PR metrics pending)

Description

compute/ is the recommended dispatch surface for backend-agnostic GPU computing but has no README. All other GPU-related modules (vcl, cuda, vulkan) have READMEs.

Task

Create compute/README.md explaining:

  1. The compute abstraction layer
  2. How it dispatches to vcl/cuda/vulkan backends
  3. Available operations (element-wise, BLAS, reduce)
  4. Basic usage example

Verification

  • README links correctly to backend-specific docs

Contributor guide

Research direction
Examine the existing READMEs in vcl/, cuda/, vulkan/ directories for style and content, then read the compute/ source code to understand the dispatch mechanism. Write the README following the same pattern.
Tech stack
None
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitBasic understanding of V language
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85