knowledge-sync

Detect stale AGENTS.md files and guide documentation updates via git.

56|18|Updated Apr 26, 2022
One-click install
npx skills add https://github.com/nuclia/frontend --skill knowledge-sync-nuclia
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: knowledge-sync
Source: https://github.com/nuclia/frontend/tree/main/.claude/skills/knowledge-sync
Command: npx skills add https://github.com/nuclia/frontend --skill knowledge-sync-nuclia

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill ensures that AI agent documentation, including root and per-project AGENTS.md files, as well as knowledge embedded in skills and agents, remains accurate and up-to-date with the codebase. This prevents AI agents from operating with outdated information.

Core Features & Use Cases

  • Staleness Detection: Identifies outdated documentation by comparing source file modification times with documentation files.
  • Automated Updates: Guides the process of creating or updating AGENTS.md files for new or modified projects.
  • Scope Management: Supports syncing based on specific commits, branch differences, or a full repository audit.
  • Use Case: After a pull request merges, this skill can automatically check if any code changes in apps/ or libs/ require updates to their respective AGENTS.md files, prompting the developer to make necessary corrections.

Quick Start

Run the knowledge sync skill to check for any documentation that needs updating based on recent code changes.

Frequently Asked Questions about knowledge-sync

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep AI agent documentation in sync with my codebase?

To keep AI agent documentation in sync with your codebase, you detect stale AGENTS.md files by comparing source modification times and guide manual updates based on recent code changes in apps or libs.

What is staleness detection for AGENTS.md files?

Staleness detection for AGENTS.md files is the process of identifying outdated AI documentation by comparing source file modification times against documentation files to prevent agents from operating with obsolete information.

How do I identify outdated documentation after a pull request merges?

You identify outdated documentation after a pull request merges by running a knowledge sync check against specific commits or branch differences to see if code changes require AGENTS.md updates.

Can I sync AI documentation for a specific commit in a monorepo?

Yes, you can sync AI documentation for a specific commit in a monorepo by utilizing git commands to identify branch differences and managing documentation scope from a full repository audit down to individual projects.

Does documentation synchronization automatically rewrite AGENTS.md files?

No, documentation synchronization does not automatically rewrite files; it identifies discrepancies and guides developers through manual updates based on a defined priority for app, lib, routing, and service patterns.

What is the best way to audit embedded knowledge in skills and agents?

The best way to audit embedded knowledge in skills and agents is running a full repository sync that detects discrepancies across workspace-wide and per-project documentation using custom scripts and git commands.