adambard/learnxinyminutes-docs

[SML/en] No section explaining signatures and structures.

Open

#2839 opened on Sep 6, 2017

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (10,755 stars) (3,235 forks)batch import
help wanted

Description

I think it would be very helpful if there could also be a section on signatures and structures in SML.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
feature
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
SML basicsLearn X in Y minutes format
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Review the existing SML file at `learnxinyminutes docs/sml.html.markdown` to understand the current structure and format. Then, research SML signatures and structures from official documentation or reputable sources. Write a new section explaining signatures and structures, following the same style as other sections. Ensure to include code examples. Finally, submit a pull request. The issue has one comment (from the author) that may provide additional context.