Skip to content

docs: Add javadoc for interactions.{services,models,errors}, switch to mvn dokka:dokka.#946

Open
copybara-service[bot] wants to merge 1 commit intomainfrom
copybara_900199054
Open

docs: Add javadoc for interactions.{services,models,errors}, switch to mvn dokka:dokka.#946
copybara-service[bot] wants to merge 1 commit intomainfrom
copybara_900199054

Conversation

@copybara-service
Copy link
Copy Markdown
Contributor

@copybara-service copybara-service Bot commented Apr 15, 2026

docs: Add javadoc for interactions.{services,models,errors}, switch to mvn dokka:dokka.

  1. Created packages.md and updated the pom.xml to point to it - This allows Dokka to correctly populate the "Description" column on the main landing page table, which was previously empty for many packages.
  2. Marked packages as experimental
    • Added bold EXPERIMENTAL: tags to the descriptions of all interactions packages in packages.md.
  3. Updated Documentation Workflows
    • .github/workflows/publish-javadoc.yml - chang the command from mvn dokka:javadoc to mvn dokka:dokka. This switches the public documentation website to Dokka's native HTML format, which correctly handles Markdown and mixed Java/Kotlin sources.
    • Moved examples-and-javadoc.yml to pre-release tests, and use run mvn -B -ntp package -DskipTests=true. this is more inline with how we run releases.

@copybara-service copybara-service Bot changed the title docs: Add javadoc for interactions.{models,services} docs: Add javadoc for interactions.{services,models,errors}, switch to mvn dokka:dokka. Apr 28, 2026
@MarkDaoust MarkDaoust force-pushed the copybara_900199054 branch from d8c6c95 to c1deeee Compare May 5, 2026 21:47
@copybara-service copybara-service Bot force-pushed the copybara_900199054 branch 3 times, most recently from 7c207a1 to 18ee927 Compare May 5, 2026 23:54
…o `mvn dokka:dokka`.

1. Created packages.md and updated the pom.xml to point to it - This allows Dokka to correctly populate the "Description" column on the main landing page table, which was previously empty for many packages.
2. Marked packages as experimental
   - Added bold EXPERIMENTAL: tags to the descriptions of all interactions packages in packages.md.
3. Updated Documentation Workflows
   - .github/workflows/publish-javadoc.yml - chang the command from `mvn dokka:javadoc` to `mvn dokka:dokka`. This switches the public documentation website to Dokka's native HTML format, which correctly handles Markdown and mixed Java/Kotlin sources.
   - Moved examples-and-javadoc.yml to pre-release tests, and use `run mvn -B -ntp package -DskipTests=true`. this is more inline with how we run releases.

PiperOrigin-RevId: 900199054
@copybara-service copybara-service Bot force-pushed the copybara_900199054 branch from 18ee927 to 6a4c30c Compare May 6, 2026 00:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant