Name: README
Author: WillWhittakerDHP

Prompt file imported from WillWhittakerDHP/LEGACY_DHP_Differential_Scheduler (.cursor/commands/readme/README.md). Copyright stays with the author.

README Management Commands

Commands for managing README files, detecting temporary documentation, consolidating content, and maintaining documentation standards.

Overview

This module provides commands to create, validate, audit, and manage README files across the codebase. It helps maintain documentation standards, detect temporary files, consolidate duplicate content, and prevent documentation bloat.

Quick Reference

See QUICK_REFERENCE.md for a one-page lookup table.

Command Categories

Atomic Commands

/readme-create [filePath] [type] [title] [purpose] - Create README with template
/readme-audit [directory] - Audit READMEs in directory
/readme-validate [filePath] - Validate README structure
/readme-extract-section [filePath] [section] - Extract specific section
/readme-mark-temporary [filePath] [reason] [expiry?] [consolidateInto?] - Mark README as temporary
/readme-detect-temporary [filePath] - Detect if README is temporary
/readme-consolidate-findings [tempReadme] [targetReadme] - Consolidate temporary findings

Composite Commands

/readme-audit-all - Audit all READMEs in .cursor folder
/readme-consolidate [sources...] [target] - Consolidate multiple READMEs
/readme-split [filePath] [sections...] - Split large README into README + GUIDE
/readme-cleanup-temporary [directory] [options] - Clean up temporary READMEs
/readme-workflow-cleanup [tier] [identifier] - Workflow-integrated cleanup

Usage Examples

Create a New README

``` /readme-create .cursor/commands/new-module/README.md module "New Module" "Commands for new module functionality" ```

Mark File as Temporary

``` /readme-mark-temporary .cursor/commands/STATUS.md "Implementation status tracking" 2025-02-27 .cursor/commands/README.md ```

Audit All READMEs

``` /readme-audit-all ```

Clean Up Temporary Files

``` /readme-cleanup-temporary .cursor --auto-consolidate ```

Programmatic Usage

```typescript import { createReadme, auditAllReadmes, cleanupTemporaryReadmes } from './cursor/commands/readme';

// Create README await createReadme({ filePath: '.cursor/commands/new-module/README.md', type: 'module', title: 'New Module', purpose: 'Commands for new module functionality', });

// Audit all READMEs const report = await auditAllReadmes(); console.log(report);

// Cleanup temporary files await cleanupTemporaryReadmes('.cursor', { autoConsolidate: true }); ```

Related Documentation

QUICK_REFERENCE.md - One-page command lookup
README Standards - Documentation standards and guidelines
Templates - README templates for different types

Install README and it becomes one more candidate the router can pick - when it fits.

A listing is a routing target with a manifest: what it does, which domains it covers, what it costs and who publishes it. Once installed it sits beside your own models and tools, is scored like any other candidate for each request, and shows up in the trace when it wins. Ratings come from workspaces that installed it, one per account.

# README Management Commands Commands for managing README files, detecting temporary documentation, consolidating content, and maintaining documentation standards. ## Overview This module provides commands to create, validate, audit, and manage README files across the codebase. It helps maintain documentation standards, detect temporary files, consolidate duplicate content, and prevent documentation bloat. ## Quick Reference See [QUICK_REFERENCE.md](./QUICK_REFERENCE.md) for a one-page lookup table. ## Command Categories ### Atomic Commands - `/readme-create [filePath] [type] [title] [purpose]` - Create README with template - `/readme-audit [directory]` - Audit READMEs in directory - `/readme-validate [filePath]` - Validate README structure - `/readme-extract-section [filePath] [section]` - Extract specific section - `/readme-mark-temporary [filePath] [reason] [expiry?] [consolidateInto?]` - Mark README as temporary - `/readme-detect-temporary [filePath]` - Detect if README is temporary - `/readme-consolidate-findings [tempReadme] [targetReadme]` - Consolidate temporary findings ### Composite Commands - `/readme-audit-all` - Audit all READMEs in .cursor folder - `/readme-consolidate [sources...] [target]` - Consolidate multiple READMEs - `/readme-split [filePath] [sections...]` - Split large README into README + GUIDE - `/readme-cleanup-temporary [directory] [options]` - Clean up temporary READMEs - `/readme-workflow-cleanup [tier] [identifier]` - Workflow-integrated cleanup ## Usage Examples ### Create a New README \`\`\` /readme-create .cursor/commands/new-module/README.md module "New Module" "Commands for new module functionality" \`\`\` ### Mark File as Temporary \`\`\` /readme-mark-temporary .cursor/commands/STATUS.md "Implementation status tracking" 2025-02-27 .cursor/commands/README.md \`\`\` ### Audit All READMEs \`\`\` /readme-audit-all \`\`\` ### Clean Up Temporary Files \`\`\` /readme-cleanup-temporary .cursor --auto-consolidate \`\`\` ### Programmatic Usage \`\`\`typescript import { createReadme, auditAllReadmes, cleanupTemporaryReadmes } from './cursor/commands/readme'; // Create README await createReadme({ filePath: '.cursor/commands/new-module/README.md', type: 'module', title: 'New Module', purpose: 'Commands for new module functionality', }); // Audit all READMEs const report = await auditAllReadmes(); console.log(report); // Cleanup temporary files await cleanupTemporaryReadmes('.cursor', { autoConsolidate: true }); \`\`\` ## Related Documentation - [QUICK_REFERENCE.md](./QUICK_REFERENCE.md) - One-page command lookup - [README Standards](../../../README_AUDIT_REPORT.md) - Documentation standards and guidelines - [Templates](./templates/) - README templates for different types

{ "prompt": "# README Management Commands\n\nCommands for managing README files, detecting temporary documentation, consolidating content, and maintaining documentation standards.\n\n## Overview\n\nThis module provides commands to create, validate, audit, and manage README files across the codebase. It helps maintain documentation standards, detect temporary files, consolidate duplicate content, and prevent documentation bloat.\n\n## Quick Reference\n\nSee [QUICK_REFERENCE.md](./QUICK_REFERENCE.md) for a one-page lookup table.\n\n## Command Categories\n\n### Atomic Commands\n\n- `/readme-create [filePath] [type] [title] [purpose]` - Create README with template\n- `/readme-audit [directory]` - Audit READMEs in directory\n- `/readme-validate [filePath]` - Validate README structure\n- `/readme-extract-section [filePath] [section]` - Extract specific section\n- `/readme-mark-temporary [filePath] [reason] [expiry?] [consolidateInto?]` - Mark README as temporary\n- `/readme-detect-temporary [filePath]` - Detect if README is temporary\n- `/readme-consolidate-findings [tempReadme] [targetReadme]` - Consolidate temporary findings\n\n### Composite Commands\n\n- `/readme-audit-all` - Audit all READMEs in .cursor folder\n- `/readme-consolidate [sources...] [target]` - Consolidate multiple READMEs\n- `/readme-split [filePath] [sections...]` - Split large README into README + GUIDE\n- `/readme-cleanup-temporary [directory] [options]` - Clean up temporary READMEs\n- `/readme-workflow-cleanup [tier] [identifier]` - Workflow-integrated cleanup\n\n## Usage Examples\n\n### Create a New README\n\n\\`\\`\\`\n/readme-create .cursor/commands/new-module/README.md module \"New Module\" \"Commands for new module functionality\"\n\\`\\`\\`\n\n### Mark File as Temporary\n\n\\`\\`\\`\n/readme-mark-temporary .cursor/commands/STATUS.md \"Implementation status tracking\" 2025-02-27 .cursor/commands/README.md\n\\`\\`\\`\n\n### Audit All READMEs\n\n\\`\\`\\`\n/readme-audit-all\n\\`\\`\\`\n\n### Clean Up Temporary Files\n\n\\`\\`\\`\n/readme-cleanup-temporary .cursor --auto-consolidate\n\\`\\`\\`\n\n### Programmatic Usage\n\n\\`\\`\\`typescript\nimport { \n createReadme, \n auditAllReadmes, \n cleanupTemporaryReadmes \n} from './cursor/commands/readme';\n\n// Create README\nawait createReadme({\n filePath: '.cursor/commands/new-module/README.md',\n type: 'module',\n title: 'New Module',\n purpose: 'Commands for new module functionality',\n});\n\n// Audit all READMEs\nconst report = await auditAllReadmes();\nconsole.log(report);\n\n// Cleanup temporary files\nawait cleanupTemporaryReadmes('.cursor', { autoConsolidate: true });\n\\`\\`\\`\n\n## Related Documentation\n\n- [QUICK_REFERENCE.md](./QUICK_REFERENCE.md) - One-page command lookup\n- [README Standards](../../../README_AUDIT_REPORT.md) - Documentation standards and guidelines\n- [Templates](./templates/) - README templates for different types", "variables": [], "notes": "Commands for managing README files, detecting temporary documentation, consolidating content, and maintaining documentation standards.", "metadata": { "source": { "provider": "github-cursor-commands", "repository": "https://github.com/WillWhittakerDHP/LEGACY_DHP_Differential_Scheduler", "path": ".cursor/commands/readme/README.md", "ref": "1d1659501a23cb4a6156c6e70e8ceb86e55b5663", "url": "https://github.com/WillWhittakerDHP/LEGACY_DHP_Differential_Scheduler/blob/1d1659501a23cb4a6156c6e70e8ceb86e55b5663/.cursor/commands/readme/README.md", "key": "WillWhittakerDHP/LEGACY_DHP_Differential_Scheduler/.cursor/commands/readme/README.md" } } }

README

About