docs: expand guide listing in README (10 → 27)#3
Merged
Conversation
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.
There was a problem hiding this comment.
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.
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.
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
Why
Detected during workspace-wide repo-intel doc-drift scan.
Test plan
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.mdfrom a short subset to a full table matching the active topics referenced byCLAUDE.md/AGENTS.md, and removes the staleSourcescolumn.Updates the indexes (
AGENTS.mdandCLAUDE.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.