oven-sh/bun

Documentation and Accessibility

Open

#2467 opened on Mar 23, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (90,348 stars) (4,486 forks)batch import
docsgood first issue

Description

What is the type of issue?

Something else

What is the issue?

There're a few things that I was trying to do:

  • Building from source
  • Understand how does Bun works
  • Contribute to good first issue issues
  • Etc

Basically facing difficulties to participate in this OSS.

Where did you find it?

I feel like:

  • Building Docs needs more cases on how to build in any OS, the docs only focus on MacOS
  • I think would be nice to add a section explaining Bun’s current source code “architecture”, e.g:
    • What connects to What
    • Why do we need X, why do we need Y.
    • Etc.

Contributor guide

Tech stack
zigjavascripttypescript
Domain
documentationdeveloper experience
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
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
basic knowledge of Bunfamiliarity with build systems
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Improve the building documentation at https://bun.sh/docs/project/developing to include OS specific steps (e.g., ArchLinux) and add a section explaining the source code architecture, such as component connections and the purpose of dependencies. Reference the existing gist by rafaelbreno for inspiration. Maintainers should confirm the desired structure and whether to include a high level architecture diagram.