Skip to content

🤖 Teach agents to refine component descriptions - #651

Merged
taras merged 1 commit into
mainfrom
codex/component-description-guidance
Aug 29, 2026
Merged

🤖 Teach agents to refine component descriptions#651
taras merged 1 commit into
mainfrom
codex/component-description-guidance

Conversation

@taras

@taras taras commented Aug 29, 2026

Copy link
Copy Markdown
Owner

Why

The component-description rules and the interview that produced them existed
only in the session that refined PR #634. Without a durable repository guide,
later descriptions can drift back toward engine vocabulary, duplicated reference
fields and mechanism-first prose.

What changes

Before:

The general writing guide did not say how component descriptions differ from
specification prose, and the one-component-at-a-time refinement method was not
recorded.

After:

AGENTS.md gives agents the concise mandatory rule and points to a new detailed
guide. .agents/component-descriptions.md records the complete authoring rules
and the refinement interview used to apply them across a corpus.

Review guide

Start with: AGENTS.md under “Component descriptions”

Then review:

  1. The detailed rules in .agents/component-descriptions.md.
  2. The preparation, one-component interview and final-pass workflow.

Look carefully at:

How to verify it

  • deno task lint exits 0 and confirms repository lint and formatting remain
    green. Existing warnings are unchanged by this documentation-only patch.
  • git diff --check confirms the two Markdown changes contain no whitespace
    errors.
  • The relative guide link in AGENTS.md resolves to
    .agents/component-descriptions.md.

Scope

Included

  • A concise component-description rule in AGENTS.md.
  • The complete extracted authoring rules.
  • The one-item-at-a-time refinement interview and final review procedure.

Intentionally unchanged

  • Product behavior, component declarations and existing descriptions.
  • Architecture and specifications; this records an agent writing procedure, not
    a new language contract.

Scope confirmation

  • Every changed file supports the purpose described above.
  • Unrelated cleanup and formatting changes are excluded.
  • Generated or mechanical changes are clearly identified.
  • The description matches the final diff and test results.

@github-actions

Copy link
Copy Markdown

PR #651: 🤖 Teach agents to refine component descriptions

2 files, +117 / -0

Scope

✅ PR scope looks good.

Structural

✅ No structural bloat detected.

Slop

✅ Slop indicators look low.

Static Analysis

✅ Oxlint found no issues.

Correctness

No extraneous code patterns detected.

@taras
taras force-pushed the codex/component-description-guidance branch from cb8c1d3 to 464dc87 Compare August 29, 2026 01:37
@taras
taras marked this pull request as ready for review August 29, 2026 01:37
@taras
taras merged commit d7eb0e1 into main Aug 29, 2026
30 checks passed
@taras
taras deleted the codex/component-description-guidance branch August 29, 2026 01:58
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