Skip to content

docs(start-sdk): instructions.md is not a changelog - #4207

Merged
MattDHill merged 1 commit into
live-docsfrom
docs/instructions-not-a-changelog
Oct 10, 2026
Merged

MattDHill merged 1 commit into
live-docsfrom
docs/instructions-not-a-changelog

Conversation

@MattDHill

Copy link
Copy Markdown
Member

The Agent Context page said instructions.md "tracks user-visible changes". Agents read that as an instruction to record changes there, and a reviewing agent asked for an "after updating from an older release…" paragraph in a package's instructions as a result. writing-instructions.md already says the file is a quick-start guide to the service as it is.

  • agent-context.md: instructions.md is the user's guide to the service as it is now, never a record of what changed, which belongs in releaseNotes.
  • writing-instructions.md: "What changed in an update" added to What does not belong in instructions.

Book-only correction to the published guide, so it targets live-docs; docs-backport.yml carries it to master.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@MattDHill
MattDHill requested a review from helix-a October 10, 2026 17:37
@MattDHill
MattDHill merged commit c56764b into live-docs Oct 10, 2026
9 checks passed
@MattDHill
MattDHill deleted the docs/instructions-not-a-changelog branch October 10, 2026 17:38
start9-docs-bot Bot added a commit that referenced this pull request Oct 10, 2026
Backports the following from live-docs:

- c56764b docs(start-sdk): instructions.md is not a changelog (#4207)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant