vlang/vsl

docs: expand dist/noise/roots README stubs

Open

#321 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

Three modules have minimal READMEs:

  • dist/README.md — 112 bytes
  • noise/README.md — 2 sentences
  • roots/README.md — 1 sentence

Task

Expand each README with:

  1. Module purpose and capabilities
  2. Public API listing with usage snippets
  3. Links to examples and related docs

Use metrics/README.md as reference for the expected quality level.

Verification

  • Each README covers the module's full public API

Contributor guide

Research direction
Read the existing README stubs and the reference 'metrics/README.md' for style. Then expand each module's README with purpose, public API listing, usage snippets, and links. Ensure each covers the full public API.
Tech stack
None
Domain
documentation
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
GitV
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80