Reflect the pre-merge Dokka CI gate in guidelines and skills#18
Merged
Conversation
Documentation warnings are now caught by `dokkaGenerate` in the PR build (config's `build-on-ubuntu.yml`), not only in the post-merge publish job. Update the guidelines (`running-builds`, `documentation`, `kdoc`, `javadoc`), the `pre-pr` and `review-docs` skills, and the `run-build` command so they no longer state that Dokka runs "only in the publish CI job". The publish job is now described as a backstop. https://claude.ai/code/session_01QcJcahKjYEXfaVrVrYo5sj
Contributor
There was a problem hiding this comment.
Pull request overview
Updates org-wide guidelines and agent skills to reflect that Dokka (dokkaGenerate) is now enforced during the PR build CI (with the publish job remaining as a backstop), instead of only being enforced during the publish pipeline.
Changes:
- Reworded guidance across documentation guidelines to state that unresolved KDoc/Javadoc links fail CI’s Dokka run (PR build), not just the publish job.
- Updated
pre-prandreview-docsskill text to match the new CI gate wording while keeping the local./gradlew build dokkaGeneraterecommendation unchanged. - Adjusted the
run-buildcommand guidance to align with the pre-merge Dokka CI gate.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| skills/review-docs/SKILL.md | Updates reviewer checklist wording to describe PR-build Dokka as the primary gate, publish as backstop. |
| skills/pre-pr/SKILL.md | Updates pre-PR checklist description and Dokka rationale to reflect CI Dokka run (PR build). |
| guidelines/running-builds.md | Aligns build-running guidance with the new PR-build Dokka CI enforcement. |
| guidelines/kdoc.md | Updates KDoc verification note to state failures occur in CI’s Dokka run. |
| guidelines/javadoc.md | Updates Javadoc verification note to state failures occur in CI’s Dokka run. |
| guidelines/documentation.md | Updates the buildSrc/config unresolved-link warning text to reference PR-build Dokka gate + publish backstop. |
| claude/commands/run-build.md | Updates build-command decision guidance to reference CI Dokka run rather than publish-only failures. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
armiol
approved these changes
Jun 15, 2026
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.
Context
Companion to SpineEventEngine/config#689, which makes the PR build run
dokkaGenerate(config's distributedbuild-on-ubuntu.yml). Documentation warnings are now caught during PR review, not only in the post-merge publish job.Change
Several guidelines and skills stated that an unresolved KDoc/Javadoc link fails "only in the publish CI job". That is no longer accurate once the PR build runs Dokka, so update them to describe CI's Dokka run (the PR build) as the gate, with the publish job as a backstop:
guidelines/running-builds.mdguidelines/documentation.mdguidelines/kdoc.mdguidelines/javadoc.mdskills/pre-pr/SKILL.md(frontmatter + body)skills/review-docs/SKILL.mdclaude/commands/run-build.mdThe guidance to run
./gradlew build dokkaGeneratelocally (and inpre-pr) is unchanged — it still gives the earliest feedback, before pushing.Notes
These are text-only edits to floating org-wide docs; no behaviour change here. The behaviour change lives in the config PR.
https://claude.ai/code/session_01QcJcahKjYEXfaVrVrYo5sj
Generated by Claude Code