Skip to content

docs(agents): surface docs/solutions/ corpus in AGENTS.md#84

Merged
brettdavies merged 1 commit into
devfrom
docs/agents-md-surface-solutions-corpus
Jun 4, 2026
Merged

docs(agents): surface docs/solutions/ corpus in AGENTS.md#84
brettdavies merged 1 commit into
devfrom
docs/agents-md-surface-solutions-corpus

Conversation

@brettdavies

Copy link
Copy Markdown
Owner

Summary

Adds a ## Documented Solutions section to AGENTS.md so agents reading the canonical instruction file discover docs/solutions/. Mirrors the equivalent block that already exists in CLAUDE.md.

AGENTS.md is the source of truth per the "see AGENTS.md; use CLAUDE.md only if the repo still keeps a compatibility shim" rule, but the docs/solutions/ knowledge-store mention previously only lived in CLAUDE.md. A cross-tool collaborator, a fresh session, or any agent reading via gh repo view would not learn that documented solutions exist and are searchable via qmd query "<topic>" --collection solutions.

Surfaced by the /ce-compound Discoverability Check during the worktree-isolation stale-base learning doc.

Type of Change

  • docs: Documentation update

Related Issues/Stories

  • Companion learning: docs/solutions/workflow-issues/claude-code-worktree-isolation-stale-base-2026-06-04.md (committed to the symlinked solutions-docs repo at main).

Testing

  • N/A (documentation-only change)

Test Summary:

  • Markdownlint clean (markdownlint-cli2 v0.22.1).
  • No code changes; existing CI runs (fmt, clippy, test, security audits, package check, shellcheck, drift-check) are not affected.

Files Modified

Modified:

  • AGENTS.md: appended a 5-line ## Documented Solutions section after External signal / research. Informational voice (not imperative). Path, frontmatter hint, and qmd query pointer mirror the existing CLAUDE.md block.

Created:

  • None.

Renamed:

  • None.

Deleted:

  • None.

Breaking Changes

  • No breaking changes

Deployment Notes

  • No special deployment steps required

Checklist

  • Code follows project conventions and style guidelines
  • Commit messages follow Conventional Commits
  • Self-review of code completed
  • Tests added/updated and passing (N/A, docs-only)
  • No new warnings or errors introduced
  • Changes are backward compatible

AGENTS.md is the canonical instruction file for this repo per the global
"see AGENTS.md; use CLAUDE.md only if the repo still keeps a compatibility
shim" rule, but the docs/solutions/ knowledge-store mention only lived in
CLAUDE.md. An agent reading only AGENTS.md (cross-tool collaborators,
fresh sessions, the gh CLI's view of the repo) would not discover that
documented solutions to past problems are searchable via
`qmd query "<topic>" --collection solutions`.

Add a small `## Documented Solutions` section after `External signal /
research` mirroring CLAUDE.md's existing block. Five lines; informational
voice, not imperative; no duplication of CLAUDE.md content.

Surfaced by /ce-compound's Discoverability Check during the
worktree-isolation stale-base learning doc.
@brettdavies brettdavies merged commit 07ae07b into dev Jun 4, 2026
8 checks passed
@brettdavies brettdavies deleted the docs/agents-md-surface-solutions-corpus branch June 4, 2026 18:36
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