Skip to content

Commit 3bedf1d

Browse files
danbarrclaude
authored andcommitted
Clarify auto-generated reference docs PR description (#721)
Expand the PR body to list exactly which files are included (CLI reference, API spec, CRD spec, registry schemas) and which are not (guides, tutorials, conceptual docs). Tag the release cutter in the description and set review expectations for a quick merge. Co-authored-by: Dan Barr <6922515+danbarr@users.noreply.github.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent c475bd5 commit 3bedf1d

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

.github/workflows/update-toolhive-reference.yml

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,24 @@ jobs:
9090
title: |
9191
Update ToolHive reference docs for ${{ steps.imports.outputs.version }}
9292
body: |
93-
This PR updates the ToolHive CLI and API reference documentation for release: ${{ steps.imports.outputs.version }}.
93+
This PR was auto-generated from ToolHive release **${{ steps.imports.outputs.version }}**.${{ steps.get-reviewer.outputs.assign_to != '' && format(' @{0} is tagged as the person who cut this release.', steps.get-reviewer.outputs.assign_to) || '' }}
94+
95+
## What's in this PR
96+
97+
Only machine-generated reference files that are built from the ToolHive source code during the release process:
98+
99+
- **CLI reference** (`docs/toolhive/reference/cli/`) - help text for every `thv` command
100+
- **REST API spec** (`static/api-specs/toolhive-api.yaml`) - OpenAPI/Swagger spec
101+
- **CRD API spec** (`docs/toolhive/reference/crd-spec.md`) - Kubernetes CRD reference
102+
- **Registry JSON schemas** (`static/api-specs/*.schema.json`) - registry validation schemas
103+
104+
## What's NOT in this PR
105+
106+
This PR does **not** contain guide, tutorial, or conceptual content. Any documentation updates beyond reference files are handled in separate, manually authored PRs.
107+
108+
## Review guidance
109+
110+
These files are generated directly from the ToolHive source and are not hand-edited. A quick scan for obvious issues is sufficient - this is intended to be merged shortly after the release is cut so the docs stay in sync.
94111
commit-message: |
95112
Update ToolHive reference docs for ${{ steps.imports.outputs.version }}
96113
labels: |

0 commit comments

Comments
 (0)