gleam-lang/gleam

Surface supported target in the generated docs

Open

#3,684 opened on Oct 10, 2024

View on GitHub
 (0 comments) (3 reactions) (0 assignees)Rust (960 forks)batch import
help wanted

Repository metrics

Stars
 (21,417 stars)
PR merge metrics
 (Avg merge 10d 19h) (69 merged PRs in 30d)

Description

Since the compiler already knows the target where each function can run it would be nice if this information could be surfaced in the generated documentation as well

Contributor guide

Research direction
Investigate the compiler's target tracking and its integration with the documentation generator to expose the supported target for each function.
Tech stack
rust
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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
RustGleam
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60