Tech debt clean-up in skills for rel note workflow - #7778
Open
knylander-grafana wants to merge 1 commit into
Open
Tech debt clean-up in skills for rel note workflow#7778knylander-grafana wants to merge 1 commit into
knylander-grafana wants to merge 1 commit into
Conversation
Signed-off-by: Kim Nylander <kim.nylander@grafana.com>
knylander-grafana
requested review from
mapno,
mdisibio and
yvrhdn
as code owners
August 18, 2026 00:23
knylander-grafana
requested review from
carles-grafana,
electron0zero,
ie-pham,
javiermolinar,
mattdurham,
ruslan-mikhailov,
stoewer,
zalegrala and
zhxiaogg
as code owners
August 18, 2026 00:23
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Tempo’s documentation-agent / skill support files to reduce tech debt around the release notes workflow: fixing/retargeting references after the shared-resource move to .claude/skills/shared/, scoping always-on release-notes instructions to “style-only” for routine edits, and updating shared-resource inventories.
Changes:
- Refines
.github/instructions/docs/release-notes.instructions.mdso routine edits only load style guidance, while new-version / patch work loads the full workflow. - Updates skill/shared-resource documentation to mention new shared resources and their intended usage.
- Retargets parts of
.agents/README.mdto reference the new shared-resource location.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/project-context.md | Adds release-notes-placement.md to the “agent and skill resources” index. |
| .github/instructions/docs/release-notes.instructions.md | Splits release-notes guidance into an always-on style block vs. conditional workflow loading. |
| .claude/skills/shared/README.md | Documents release-notes-placement.md and vale-compact.sh as shared resources and updates release-notes usage pointers. |
| .claude/skills/README.md | Adds release-notes-placement.md to the shared resources table. |
| .agents/README.md | Updates references for the moved release-notes workflow and adjusts release-notes workflow instructions. |
Suppressed comments (1)
.agents/README.md:165
- MEDIUM: This link still points to
doc-agents/shared/style-guide.md, but the style guide lives under.claude/skills/shared/now. As-is, the release-notes workflow instructions include a dead link.
1. Follow [`release-notes-workflow.md`](../.claude/skills/shared/release-notes-workflow.md) — it covers the full process from source curation (Phase 0) through final polish (Phase 5).
2. At Phase 1.5, run `/docs-pr-check` to assess documentation status for each PR.
3. At Phase 1.75, run `/docs-pr-write` to fill documentation gaps.
4. Reference [`style-guide.md`](doc-agents/shared/style-guide.md) throughout for formatting and conventions.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
114
to
+118
| | [`best-practices.md`](doc-agents/shared/best-practices.md) | Pre-writing checklist, common pitfalls, documentation patterns (for human writers) | | ||
| | [`verification-checklist.md`](doc-agents/shared/verification-checklist.md) | Comprehensive pre-submission checklist for accuracy, consistency, and completeness | | ||
| | [`release-notes-workflow.md`](doc-agents/shared/release-notes-workflow.md) | Multi-phase workflow for creating release notes, from CHANGELOG curation through final polish | | ||
| | [`metrics-generator-knowledge.md`](doc-agents/shared/metrics-generator-knowledge.md) | Pointer to `modules/generator/AGENTS.md` (metrics-generator domain knowledge) | | ||
|
|
||
| The release notes workflow moved to [`.claude/skills/shared/release-notes-workflow.md`](../.claude/skills/shared/release-notes-workflow.md) (#7446) — it's no longer under `doc-agents/shared/`. |
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.
What this PR does:
Ancillary skill changes to clean up tech debt related to the changed release-notes-workflow.md file.
Made with the help of Claude.
Which issue(s) this PR fixes:
Related to: #7777
Part of #7776
Checklist
.chloggen/(runmake chlog-new, ormake chlog-new FILENAME=<name>to override the default branch-name file; see.chloggen/README.md)