Repository navigation
Shape the Kotlin and Scala Server docs' "What is on here" as a capability directory - #127
Merged
Merged
Conversation
why: Each group of the Kotlin `Server` KDoc's "What is on here" section mixed guidance and `[name]` references in one paragraph, so libtmux.org rendered it as prose, where the Java `Server` page draws a capability directory. The site draws one only when a bold-led paragraph of guidance is followed by a paragraph that holds nothing but references, in three groups or more. libtmux/docs#231 teaches the parser KDoc's reference syntax. what: - Keep the introduction, the group titles and the guidance of every group word for word, since its sentences tell members apart by name - Follow each group's guidance with one paragraph of the members it covers, as the `[name]` and `[label][target]` references the comment already used; types stay in the guidance only - Give the closing paragraph about `cmd`, `run`, `batch`, `chain` and `asJava` its own group, "Running a command"
why: Each group of the Scala `Server` Scaladoc's "What is on here" section mixed guidance and `[[name]]` references in one paragraph, so libtmux.org rendered it as prose, where the Java `Server` page draws a capability directory. The site draws one only when a bold-led paragraph of guidance is followed by a paragraph that holds nothing but references, in three groups or more. libtmux/docs#231 teaches the parser Scaladoc's reference syntax. what: - Keep the introduction, the group titles and the guidance of every group word for word, since its sentences tell members apart by name - Follow each group's guidance with one paragraph of the members it covers, as the `[[name]]` references the comment already used; types stay in the guidance only - Give the closing paragraph about `cmd`, `run`, `batch` and `chain` its own group, "Running a command"
tony
marked this pull request as ready for review
November 1, 2026 14:59
tony
added a commit
that referenced
this pull request
Nov 1, 2026
why: Cut 0.1.2 from master so the test-run sandbox guard (#123) and its cli await fix (#130), the per-module changelogs (#125) and the Kotlin and Scala Server capability directory (#127) ship. The install snippets and the examples' snapshot coordinates need to name the release that ships them. what: - Date the 0.1.2 section (2026-11-01) in the root changelog and in each module's, and keep an empty unreleased section above it; the modules with nothing new say so - Move the install snippets and the examples' snapshot coordinates to 0.1.2 - Set the development version to 0.1.2-SNAPSHOT; libtmuxApiBaseline stays until 0.1.2 is published
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #126
Part of libtmux/docs#231
The Kotlin
ServerKDoc and the ScalaServerScaladoc now have the shape the docs site draws as a capability directory (groupDirectory), as the JavaServerpage already does: eight groups in each, a bold-led paragraph of guidance followed by a paragraph that holds only references. Until now each group mixed guidance and references in one paragraph, so libtmux.org rendered Kotlin and Scala as prose.[name]and[label][target]references and the Scaladoc[[name]]references the comments already used; types stay in the guidance only.cmd,run,batch,chainandasJava(Kotlin) andcmd,run,batchandchain(Scala) is now its own group, "Running a command".Sessionalready draws a directory on the Java side, and the Kotlin and ScalaSession,WindowandPanecomments have no grouped sections, so the issue's last bullet has nothing more to restructure.The site does not read KDoc's
[label][target]or Scaladoc's[[name]]references in the directory yet; libtmux/docs#231 adds them ([name]is already read). Until that lands the sections read as ordinary Markdown, which Dokka and Scaladoc render as before.Checked:
./gradlew :libtmux-scala:scaladocSite :libtmux-kotlin:dokkaGeneratePublicationHtmlsucceeds; the scaladoc task fails on an unresolved link and its two warnings are inObservation.scala, and Dokka links exactly the references it linked before the change