facebook/flow

Improce docs & examples for interfaces, modules, classes, etc.

Open

#3,682 opened on Apr 7, 2017

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Rust (22,203 stars) (1,885 forks)batch import
Accepting PRshelp wanted

Description

hi, I find it very hard to move into imports, exports, declares, modules, successfully with flow, I have failed so far. And reading other issues has made it appear to me that other (even smart) people have been tripped up by all this random example: https://github.com/facebook/flow/issues/769. Thus I would like to suggest that somebody who really groks this stuff does some pair documenting with somebody who doesn't, to work up some succinct but fully fleshed out examples.

Contributor guide

Tech stack
javascript
Domain
documentation
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.
1-2 days
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.
mostly clear
Prerequisites
Basic knowledge of JavaScriptFamiliarity with Flow type system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
The issue requests improved documentation and examples for Flow's interfaces, modules, classes, and related concepts. The body references issue #769, which may contain additional context. Maintainers should identify specific gaps in the current documentation, possibly by reviewing existing docs and examples. Then create concise, step by step examples covering imports, exports, declares, and modules. The work should be coordinated with maintainers to ensure accuracy.