sue-doc-code-consistency

Audit DeepResearch SUE framework documentation for consistency and doc-code alignment.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/dongzhuoyao/deepresearch --skill sue-doc-code-consistency
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sue-doc-code-consistency
Source: https://github.com/dongzhuoyao/deepresearch/tree/main/.codex/skills/sue-doc-code-consistency
Command: npx skills add https://github.com/dongzhuoyao/deepresearch --skill sue-doc-code-consistency

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the risk of broken workflows, user errors, and misaligned implementation caused by stale, inconsistent, or incomplete documentation for the DeepResearch SUE scale-up experiment framework.

Core Features & Use Cases

  • 13 Focused Audit Functions: Validates skill frontmatter, cross-references, documentation completeness, semantic correctness, stale links, site consistency, contract coverage, version history, workspace docs, doc update triggers, README accuracy, regression detection, and doc-code mismatches.
  • Dual Mode Operation: Runs as a subagent of sue-overall-audit for full framework audits, or standalone for targeted documentation checks like verifying docs match code or detecting stale references.
  • Use Case: A research team updating SUE skills can run this audit to ensure all documentation reflects current skill behavior, no cross-references are broken, and all canonical contracts are properly documented.

Quick Start

Use the sue-doc-code-consistency skill to run a full documentation audit of the DeepResearch SUE framework and identify all doc-code mismatches and stale references.

Frequently Asked Questions about sue-doc-code-consistency

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

FAQPage Schema
How do I audit ML experiment documentation for consistency and code alignment?

Auditing ML experiment documentation for consistency involves checking SKILL.md frontmatter, cross-references, and generated GitHub Pages docs against actual code. This detects stale content, validates workflow topology references, and ensures canonical contract compliance.

What is stale doc detection and when do I need it for SUE framework skills?

Stale doc detection identifies obsolete references and doc-code mismatches in SUE framework documentation. You need it when updating skills to prevent broken workflows, user errors, and misaligned implementation caused by outdated markdown files or invalid cross-references.

How do I validate skill frontmatter requirements and cross-references in markdown docs?

Validating skill frontmatter requirements and cross-references involves scanning SKILL.md files to enforce compliance with canonical contracts and check semantic accuracy. It detects broken workflow topology references and ensures documentation completeness across the workspace.

Can I run a standalone documentation audit for doc-code mismatches without a full framework review?

Yes, you can run a standalone documentation audit for doc-code mismatches without a full framework review. It operates in dual mode, allowing targeted checks for stale references and semantic accuracy independently of broader system audits.

Why does my documentation audit keep showing broken cross-references in generated GitHub Pages docs?

Your documentation audit shows broken cross-references in generated GitHub Pages docs due to stale content and unoperationalized shared contracts. Running a consistency check detects these mismatches, validates workflow topology references, and enforces canonical skill contract compliance.