Repository navigation
chore(packages): comments say why, never what; long ones move to docs/ (CL-8376) - #847
Merged
Merged
Conversation
TheGreatAxios
force-pushed
the
cl-8376-packages-comments
branch
from
September 18, 2026 01:55
5525238 to
e4c487c
Compare
…ry-publish, agent-events, approvals, collections, cron, error-sink, code-review Long comment blocks that only restated what the code does are removed or shortened to a line or two of real rationale. A few genuinely deep explanations move to new docs/ files with a one-line link left in place.
Deep implementation rationale for source-tree validation, run-outcome status, agent-session provisioning, and the authoring registry moves to new docs/ files with a one-line link left in place.
Covers inventory, validation, routes, capability-inventory, capability-add, agent-definition-drafting, one-shot-prompt, asset-write, id-leak-guard, sanitize-inventory-text, tool-package-version. The archive/restore lifecycle invariant for agent definitions moves to docs/agent-definition-status-lifecycle.md.
Covers visible-definitions, workflow-create-routes, workflow-capability-routes. The self-update authorization rationale moves to docs/workflow-capability-authorization.md.
Trim remaining comments in agent-directory, url-path, and cron to a short why rather than a restatement of what the code does.
Follow-up trim after rebasing onto main: shorten remaining 4-6 line module-header comments across agent-directory, inference-catalog, and workflows to the target 1-3 line why.
TheGreatAxios
force-pushed
the
cl-8376-packages-comments
branch
from
September 18, 2026 01:57
e4c487c to
608f298
Compare
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.
Summary
packages/*/src, excludingmigration-runner,hub-api-client, andcredential-providers(being deleted by other PRs).docs/*.mdfiles with a one-line pointer left in code.Docs added
Test plan
bun run check(typecheck, lint, fmt, test) green