Skip to content

Add searchable PF4J 3.15.0 API reference - #37

Open
Arinbus wants to merge 1 commit into
pf4j:masterfrom
Arinbus:docs/sourcey-pf4j-api
Open

Add searchable PF4J 3.15.0 API reference#37
Arinbus wants to merge 1 commit into
pf4j:masterfrom
Arinbus:docs/sourcey-pf4j-api

Conversation

@Arinbus

@Arinbus Arinbus commented Aug 6, 2026

Copy link
Copy Markdown

Summary

  • publish a searchable PF4J 3.15.0 API reference at /api/
  • replace the existing 2.4.0-only JavaDoc navigation page with links to the current reference and archived versions
  • include a reproducible, version-pinned Doxygen → Moxygen → Sourcey build under sourcey-api/

Why

The current Reference page points only to PF4J 2.4.0 on javadoc.io. This adds a project-owned reference for the current 3.15.0 release with exact-source links, full-text search, stable canonical URLs, and llms.txt exports.

Reproducibility and scope

  • PF4J release commit: 2ce777013963706c868b79da1483270e2690afab
  • Sourcey: 3.6.5 (exact lockfile integrity)
  • Moxygen: 2.1.12 (exact lockfile integrity)
  • generated output: 97 HTML pages, 1,054 search entries, 933 links to exact source lines
  • repository change: 201 generated /api/ files plus 14 build/source files; no workflow is added
  • generated output is committed so the existing Jekyll/GitHub Pages path can publish it directly

Rebuild:

cd sourcey-api
npm run build:all

The build uses npm ci --ignore-scripts, checks out the immutable PF4J release commit, regenerates the site, copies third-party notices, and runs scripts/verify-output.py.

Verification

{"broken_local_links":0,"canonical_pages":97,"generator_pages":97,"html_pages":97,"search_index_entries":1054,"source_links":933,"status":"valid"}

Also verified locally:

  • HTTP 200 for /api/, representative API page, search index, llms.txt, and OG image
  • browser render and search behavior; zero console/JavaScript errors
  • no private paths, credentials, cache files, or files over 1 MiB
  • git diff --check passes

Licensing

The generated site includes Sourcey's AGPL-3.0 license text and a third-party notice with exact package integrity values. PF4J source links and the footer retain the project's Apache-2.0 attribution.

Signed-off-by: Nika Greenberg <110728128+Arinbus@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant