Documentation: Publish Javadoc API documentation to GitHub Pages

[sfloess]

Overview

JNexus has excellent Javadoc coverage but no published API documentation site. This would help external developers integrate with jnexus-core.

Current State

• Extensive Javadoc comments in source code
• Maven javadoc plugin configured
• No public API documentation site

Proposed Solution

1. Generate Javadoc in CI:

Add to .github/workflows/main.yml:

- name: Generate Javadoc
  run: mvn javadoc:aggregate
  
- name: Deploy to GitHub Pages
  if: github.ref == 'refs/heads/main'
  uses: peaceiris/actions-gh-pages@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    publish_dir: ./target/site/apidocs
    destination_dir: javadoc

2. Enable GitHub Pages:

• Repository Settings → Pages
• Source: gh-pages branch
• Path: /javadoc

3. Add API docs link to README.md:

## API Documentation
- [Javadoc API Reference](https://flossware.github.io/jnexus/javadoc/)

Benefits

• Discoverability for developers using jnexus-core
• Professional presentation
• Always up-to-date (auto-generated on main)
• SEO benefits for project visibility

Modules to Include

• jnexus-core (primary API)
• Desktop classes (for UI extension developers)
• Optionally: Android classes (for Kotlin developers)

Priority

Low - Nice to have, not blocking any functionality

Related

• Documentation score: 94/100 (could be 98/100 with published API docs)