javadoc and documentation missing

Open
#47 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
28/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
java, node.js
Domain
documentation

Research direction

No files or tests are named. Start by reading the DZone article and surveying the Java library and generator APIs to inventory the missing user and developer guidance. Done means the project has Javadoc and documentation covering its features, generator usage, and the requirement to install Node where the Java library is used.

Written by the indexing model from the issue text.

Description

the project looks great and there is a dzone article covering the basics. but its a pity there is no javadoc or documentation.
if you want to know of all features or want to write your own generator there is no help unfortunately :(

and theres nowhere to find, you need to have node installed on the system where you want to use it with the java-lib :D

Dominant language
TypeScript
Stars
6
Forks
2
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from vaadin/example-data

All issues in vaadin/example-data

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.