Documentation in SBK release artifacts

SBK distributes human and agent documentation with executable and library release channels so that operational and development context remains available outside a Git checkout.

Gradle application distributions

./gradlew installDist, distZip, and distTar use the root applicationDistribution configuration.

The distribution root contains:

• README.md
• AGENTS.md
• INSTRUCTIONS.md
• Agent-specific configuration files that exist in the repository

The docs/ directory contains the engineering index, architecture, repository map, driver guide, maintenance guide, recipes, specification template, toolkit, distribution guide, and detailed internals.

Verify locally:

./gradlew installDist
find build/install/sbk -maxdepth 2 -type f | sort

The definitive inclusion list is the applicationDistribution block in the root build.gradle.

Documentation JAR

Modules applying gradle/maven.gradle register a docsJar artifact with the docs classifier. It contains the root entry points, selected engineering documents, agent skills, and supported agent configuration files. Inside the JAR, docs/README.md is the documentation index and docs/PROJECT_README.md is the root product README.

Build and inspect without publishing:

./gradlew docsJar
find . -path '*/build/libs/*-docs.jar' -type f -print
jar tf <path-to-docs-jar>

Artifact names use the version from gradle.properties; documentation must not hard-code a release number.

GitHub release workflow

The release workflow:

1. Builds installed, ZIP, and TAR distributions.
2. Creates sbk-agent-docs.tar.gz from root entry points, the complete docs/ directory, and agent configurations.
3. Attaches distributions, the documentation archive, and selected standalone entry-point documents to a GitHub release.

The workflow runs only under its configured tag/release conditions. Editing this document does not publish anything.

Maven publication

gradle/maven.gradle adds docsJar to each applicable Maven publication. Publication repositories and credentials are selected by Gradle properties and environment configuration. Publishing is a maintainer action and is not part of documentation verification.

Maintenance checklist

When adding an authoritative document:

• Link it from docs/README.md.
• Add it to root applicationDistribution when executable users need it.
• Add it to docsJar when library consumers need it.
• Add it to standalone GitHub release assets only if it is a primary entry point; the documentation archive already contains the whole docs/ directory.
• Build and inspect artifacts before claiming inclusion.
• Keep file lists version-neutral and avoid fixed artifact names.

Source locations:

• Root distribution: build.gradle
• Documentation JAR: gradle/maven.gradle
• Release archive/assets: .github/workflows/gradle.yml