You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
since hosting on sonatype is a pain, using default the default site for javadocs wont work. the synopsis on the README sucks and the javadocs added during development would be much better at describing the API.
Proposed Solution
hosting the javadocs on github should work w/o a problem on a dedicated gh-pages repo / branch for the docs.
Alternative
maybe a sub-repo? or an entirely different hosting solution?
Requirements
README doesn't include an overview of the API
docs are automatically updated with each release
Additional Context
there's plenty a solution for generating the docs with maven plugins
Summary
since hosting on sonatype is a pain, using default the default site for javadocs wont work. the synopsis on the README sucks and the javadocs added during development would be much better at describing the API.
Proposed Solution
hosting the javadocs on github should work w/o a problem on a dedicated gh-pages repo / branch for the docs.
Alternative
maybe a sub-repo? or an entirely different hosting solution?
Requirements
Additional Context
Code of Conduct
The text was updated successfully, but these errors were encountered: