onex-docs-reality-sync

Inventory, update, and archive documentation to match current codebase behavior.

2|2|Updated Mar 28, 2026
One-click install
npx skills add https://github.com/Julian0444/omnicursor --skill onex-docs-reality-sync
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: onex-docs-reality-sync
Source: https://github.com/Julian0444/omnicursor/tree/main/.cursor/skills/onex-docs-reality-sync
Command: npx skills add https://github.com/Julian0444/omnicursor --skill onex-docs-reality-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill addresses documentation drift and helps maintain the alignment between the README and the docs/ folder in your codebase, simplifying inventory, updating, or archiving outdated information.

Core Features & Use Cases

  • Inventory and Align README & Docs: Provides an inventory and establishes the source of truth from the current codebase behavior.
  • Address Documentation Drift: Handles outdated paths, contradictions, and addresses them accordingly.
  • Archive Outdated Material: Moves and archives material that is no longer maintained to ensure a clean documentation base.
  • Summarize Actions: Offers a summary of the actions taken to update the documentation, ensuring the reader is informed about the changes made.

Quick Start

Execute the onex-docs-reality-sync skill to reconcile your documentation with your current codebase behavior and address any outdated information.

Frequently Asked Questions about onex-docs-reality-sync

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

FAQPage Schema
How do I keep documentation synchronized with my codebase?

To keep documentation synchronized with your codebase, this Skill inventories your README and docs folder, establishes the current codebase behavior as the source of truth, and addresses any drift or inconsistencies.

What is the best way to manage outdated documentation in a repository?

The best way to manage outdated documentation is to identify paths and contradictions, then move and archive material that is no longer maintained. This ensures a clean documentation base and informs the reader of the changes made.

How do I inventory and align my README with my docs folder?

To inventory and align your README with your docs folder, this Skill scans the current codebase behavior to establish a source of truth. It then reconciles documentation against this baseline to address drift and inconsistencies.

When should I archive outdated technical documentation?

You should archive outdated technical documentation when paths are no longer maintained or contradictions exist with the current codebase. This Skill moves and archives that material to ensure a clean documentation base and summarizes the actions taken.

Can I use this documentation synchronization approach for any software project scale?

Yes, this approach is designed for developers and documentation maintainers looking to keep technical documentation aligned with software reality. It addresses drift and inconsistencies regardless of the specific project context.