[docs] Populate documentation.instructions.md for AI agents - #5
Merged
Merged
Conversation
- Add comprehensive documentation guidelines for AI agents - Include style conventions, terminology, validation steps - Document changelog conventions and file structure - Update CHANGELOG.md to note the addition
github-actions
Bot
added
automation
documentation
krukow
approved these changes
Feb 15, 2026
krukow
disabled auto-merge
February 15, 2026 17:49
Closed
krukow
added a commit
that referenced
this pull request
Jun 2, 2026
…#116) Phase 10 self-review of the update-upstream skill after the v1.0.0-beta.12 sync surfaced documentation drift: - AGENTS.md Project Structure tree was missing `tool_set.clj` and the top-level `github.copilot-sdk` namespace (`copilot_sdk.clj`), which holds the curated public `event-types` / `session-events` sets. - references/PROJECT.md mapped the public `event-types` set to `client.clj` (it lives in `copilot_sdk.clj`) and referenced a non-existent `subscribe-events!`. Corrected, split curated-vs-generated event sets, and added the `toolSet.ts` -> `tool_set.clj` mapping. - SKILL.md gains pitfall #5: outbound optional wire fields must match upstream's omit-vs-null behavior per RPC (compute the value and gate on `(some? v)` when the request schema has no null variant, as with `session.model.switchTo`). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
2 participants
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.
Documentation Updates - February 15, 2026
This PR populates the previously empty
.github/instructions/documentation.instructions.mdfile with comprehensive guidelines for AI agents updating documentation.Changes Made
Populated
.github/instructions/documentation.instructions.mdwith:bb validate-docs)Updated
CHANGELOG.mdto document:Context
The file was created empty in commit ff7cd6f (workflow setup) but needed content for the daily-doc-updater workflow to function properly. The workflow expects to read documentation guidelines from this file before making any doc changes.
Notes