e-m-b-a/emba

Improve module documentation

Open

#1,844 opened on Jan 8, 2026

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Shell (314 forks)auto 404
EMBAdocumentationenhancementgood first issuehelp wantedstale

Repository metrics

Stars
 (3,565 stars)
PR merge metrics
 (PR metrics pending)

Description

Is your feature request related to a problem? Please describe. We started to implement some further module documentation a while ago. To move on with documentation improvements further community support would be highly appreciate.

Describe the solution you'd like A template module with some notes on the documentation is available here https://github.com/e-m-b-a/emba/blob/5cbdc191f4c19707dcec47d5652b7862b20a8a03/modules/template_module.sh#L34

Another module with implemented docs can be found here: https://github.com/e-m-b-a/emba/blob/master/modules/S04_windows_basic_analysis.sh

Contributor guide

Research direction
Follow the template module (template module.sh) and example (S04 windows basic analysis.sh) to add documentation to an existing module. Ensure to include description, author, and notes as per template.
Tech stack
shell
Domain
documentationbackend
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.
Under 1 hour
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90