airbnb/epoxy

[Feature request] Model documentation generator.

Open

#522 opened on Sep 4, 2018

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Java (8,412 stars) (738 forks)batch import
help wanted

Description

Hi! First of all, thanks for creating and open sourcing Epoxy, it really simplifies and optimizes developing features.

After extending the usage of Epoxy in a large app, and building dozens of components, we're facing a situation where sometimes models are duplicated because of members of the team don't realize they already exist.

Our suggestion would be to take advantage of the annotations and generate a centralized documentation or model catalog.

A similar tool in the react world could be React docgen

Thanks so much again for this awesome project!

Contributor guide

Tech stack
java
Domain
documentationmobile
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.
over 1 week
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
JavaAndroid developmentAnnotation processing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
Explore Epoxy's existing annotation processing code for model generation (e.g., EpoxyModelProcessor). Consider generating a HTML or JSON documentation from the annotations. Look at the react docgen tool for inspiration. The discussion in the issue may provide additional context.