Skip to content

docs: expand guide listing in README (10 → 27)#3

Merged
avifenesh merged 2 commits intomainfrom
docs/fix-drift-repo-intel-scan
Apr 14, 2026
Merged

docs: expand guide listing in README (10 → 27)#3
avifenesh merged 2 commits intomainfrom
docs/fix-drift-repo-intel-scan

Conversation

@avifenesh
Copy link
Copy Markdown
Contributor

@avifenesh avifenesh commented Apr 14, 2026

Summary

  • Expanded README guide table from 10 entries to 27 to match the index in CLAUDE.md/AGENTS.md
  • Dropped the stale Sources column from the README guide table
  • README is now aligned with the actual knowledge base content

Why

Detected during workspace-wide repo-intel doc-drift scan.

Test plan

  • CI passes
  • Counts match plugin repos

Docs-only change.


Note

Low Risk
Docs-only updates that adjust index/listing content; low risk aside from potential doc drift if topic names or filenames are mis-copied.

Overview
Expands the public guide listing in README.md from a short subset to a full table matching the active topics referenced by CLAUDE.md/AGENTS.md, and removes the stale Sources column.

Updates the indexes (AGENTS.md and CLAUDE.md) to include three new guides (rag-skill-indexing.md, codex-plugin-manifest.md, resp-mq-server-rust.md) and adds/normalizes associated trigger phrases and quick-lookup keywords for those topics.

Reviewed by Cursor Bugbot for commit 24d7846. Configure here.

README was listing 10 guides, but repo has 27 topics per CLAUDE.md/AGENTS.md index. Table updated to match source of truth and stale Sources column dropped.
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds three new research guides and updates the indexing files across the repository. The review identifies critical regressions in AGENTS.md where existing trigger phrases and lookup data were accidentally truncated. Additionally, there are duplicate trigger mappings in CLAUDE.md that could cause ambiguity for RAG systems, and the guide list in README.md is inconsistent with the primary index files.

Comment thread AGENTS.md
Comment thread AGENTS.md
Comment thread CLAUDE.md Outdated
Comment thread CLAUDE.md Outdated
Comment thread README.md
Gemini flagged that AGENTS.md and CLAUDE.md had their Trigger Phrases
and Quick Lookup sections truncated during the README expansion. This
restores the dropped entries, reconciles counts across README/CLAUDE.md/
AGENTS.md (all now list 27 guides), and resolves duplicate trigger
phrases by renaming the less-specific entries: "A2A protocol" under
ai-cli-advanced-integration becomes "A2A in AI CLI integration", and
"progressive disclosure skill" under rag-skill-indexing becomes
"progressive disclosure RAG" (kept the broader entry for skills-for-
library-and-sdk-best-practices).

Also adds previously-missing Available Topics, Trigger Phrases, and
Quick Lookup coverage for four guides that the README listed but
CLAUDE.md/AGENTS.md had never indexed (oss-org-naming-patterns,
cli-browser-automation-agents, terminal-browsers-agent-automation,
web-session-persistence-cli-agents), and restores the repo convention
of CLAUDE.md and AGENTS.md being byte-identical.
@avifenesh avifenesh merged commit 88d328e into main Apr 14, 2026
3 checks passed
@avifenesh avifenesh deleted the docs/fix-drift-repo-intel-scan branch April 14, 2026 23:27
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