Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add gh-hosted docs #104

Open
1 of 3 tasks
Jonathan-Zollinger opened this issue Mar 20, 2024 · 0 comments
Open
1 of 3 tasks

Add gh-hosted docs #104

Jonathan-Zollinger opened this issue Mar 20, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@Jonathan-Zollinger
Copy link
Member

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

  • 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

Code of Conduct

@Jonathan-Zollinger Jonathan-Zollinger added the enhancement New feature or request label Mar 20, 2024
@Jonathan-Zollinger Jonathan-Zollinger self-assigned this Mar 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant