bytecodealliance/StarlingMonkey

Add section to docs on how to debug StarlingMonkey application

Open

#266 opened on Aug 19, 2025

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C (53 forks)github user discovery
documentationhelp wanted

Repository metrics

Stars
 (271 stars)
PR merge metrics
 (Avg merge 28d 18h) (4 merged PRs in 30d)

Description

Our developer guide section on debugging is currently empty: https://bytecodealliance.github.io/StarlingMonkey/developer/debugging.html

cc: @squillace

Contributor guide

Research direction
Look at the existing debugging page (currently empty) and other documentation pages in the StarlingMonkey repo to understand the format and style. Then research common debugging techniques for StarlingMonkey applications under various runtimes (e.g., using debug logs, inspect tool in browsers, or debugging infrastructure in web assembly runtimes). Write a step by step guide on how to set up and use debugging tools, including code snippets and command examples.
Tech stack
javascriptc
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85