[Request] Javadoc and per package documentation on configuration

Open
#141 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
java
Domain
documentation

Research direction

Start with the linked light-rest-4j tutorials and Plugin Architecture documentation, then review the package configuration and handler-related material mentioned in the issue. Inventory which packages need Javadoc, README.md files, and usage docs. Done means the requested configuration, package, and handler questions are documented per package.

Written by the indexing model from the issue text.

Description

Hi,

First of all, thank you for the effort put into the project. I'm discovering it through openapitools/openapi-generator, but I'm already having to dive into the code to understand what's going on.

Following the light rest 4j tutorials, it's great that I can start the server, but it's unclear to me for example:

  • how the validation handlers are tied in
  • which config is necessary and for which package
  • what fields I can add or modify of the config
  • whether I can rename the config files
  • how I can add other light-4j packages and make then work (do I just have to add them to pom.xml? Are there any other steps?)
  • how I myself can add handlers:
  • do I need to write a HandlerProvider?
  • do I just write a handler and it's somehow discovered?
  • do I need to somehow register handlers and providers?
  • which packages I need to build a minimal server
  • etc.

I found the Plugin Architecture doc, but it doesn't answer the questions I have above.

Therefore, I suggest that each package have:

  • javadoc (javadoc.io has free hosting for projects on maven central)
  • README.md
  • docs explaining how to use them

I'll be reading through the code and probably throwing together a pull-request on light-4j or on this repo to get it started, but I'm totally new to the project, so I'd honestly feel more comfortable if it were done by somebody knowledgeable on the subject.

Dominant language
CSS
Stars
10
Forks
14
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 networknt/light-doc

All issues in networknt/light-doc

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.