reflux/refluxjs

Can we have an API reference?

Open

#291 opened on Mar 14, 2015

View on GitHub
 (6 comments) (0 reactions) (0 assignees)JavaScript (5,377 stars) (354 forks)batch import
enhancementhelp wanted

Description

As well as the general readme, I think reflux should have an API.md file that would list the properties of the definition objects that you pass into createStore, createAction etc. as well as their methods.

At the moment, even Store#getInitialState isn't even mentioned in the readme, which is very confusing. I would be happy to make a PR, but I'm sure someone with a better knowledge of the codebase would make a better API reference.

Contributor guide

Tech stack
javascriptreact
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
clear
Prerequisites
basic JavaScriptfamiliarity with Reflux APIdocumentation writing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Begin by exploring the source code, especially files like `src/createStore.js`, `src/createAction.js`, and any others that expose public API. Note all methods and properties. Then create an `API.md` file that documents these, referencing the existing README for style. Ensure to include `Store#getInitialState` as mentioned in the issue. No PRs are linked, so this is a fresh documentation task.