Skip to content

Refine release-note editing and demo media guidance - #1254

Open
yuecideng wants to merge 1 commit into
mainfrom
codex/release-notes-skill
Open

yuecideng wants to merge 1 commit into
mainfrom
codex/release-notes-skill

Conversation

@yuecideng

Copy link
Copy Markdown
Contributor

Description

Incremental release updates can accumulate repeated feature descriptions, duplicate GIF/MP4 displays, and stale dependency or CI claims. Refine the canonical release skill to keep notes concise while preserving migration guidance, attribution, original media provenance, and concurrent editorial changes.

  • Add an on-demand reference for exact commit/PR inventory, draft updates, editorial reduction, demo presentation, and scoped attachment cleanup.
  • Prefer one primary representation per demo, respect explicit requests for both formats, and validate rendered players rather than assuming every MP4 URL embeds or autoplays.
  • Distinguish local checks, main/PR CI, tag distribution validation, and published distribution status. Correct the workflow cues for PyPI and versioned docs.

Dependencies: none. Thin adapters continue routing to the canonical skill; no workflow, runtime, release draft, or publication state is changed by this PR.

Type of change

  • Documentation update / developer tooling

Validation

  • Canonical skill passed skill-creator/scripts/quick_validate.py.
  • Relative reference links, Markdown code fences, and existing adapter routing checked.
  • Manually walked incremental-update, shortening, GIF/MP4 selection, and attachment-cleanup scenarios against the instructions.
  • black . with Black 26.10.1: 2864 Python files unchanged.
  • Public API documentation coverage: 5187/5187; whitespace checks passed.
  • Context impact review: no affected topics. Existing project routing remains sufficient.

Test necessity: instructions and references only; no executable behavior or scripts changed. No runtime tests or wording-matching tests were added.

Checklist

  • Run the required formatter.
  • Review documentation and context impact.
  • Verify public API coverage.
  • Review proportional validation and test necessity.
  • Review dependencies; none added.

@yuecideng yuecideng added docs Documentation, API references and example explanations. devtools Repository development skills, agent context, code checks and contribution tooling. labels Nov 19, 2026
@greptile-apps

greptile-apps Bot commented Nov 19, 2026 •

Copy link
Copy Markdown

RetriggerView in GreptileConfidence Score: 5/5

[Medium impact] This documentation-only change appears safe to merge.

Summary

Refines the release skill with safer draft editing, shorter notes, and clearer demo media guidance. No runtime code or workflows change.

  • Release notes can be updated without losing their scope.
  • Each demo gets one clear player or preview by default.
  • Release checks distinguish tag validation from publication.

No actionable issues found.

Reviews (1) · Last reviewed commit: "docs(release): refine note editing and d..." · Reviewed by Greptile

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

devtools Repository development skills, agent context, code checks and contribution tooling. docs Documentation, API references and example explanations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant