How does it handle outdated content?

The skill proactively identifies and removes badges, deprecated sections, or instructions that can no longer be substantiated by the existing files in the repository.

Is it specifically designed for Nix dotfiles?

While it has optimized patterns for Nix-based dotfiles and specific configuration roots, it can effectively manage documentation for any repository by syncing content with the actual filesystem state.

Does this skill support multiple README files?

No, it enforces a single top-level README.md to maintain repository cleanliness and consolidates any subdirectory documentation into the root file.

Can it generate executable setup commands?

Yes, it identifies current setup requirements and provides copy-pasteable Markdown code blocks for direct execution by the user.

README Auto-Sync

Name: README Auto-Sync
Author: Kotaro7750

byKotaro7750

Learning & Documentation

Synchronizes and maintains repository documentation by aligning setup instructions and directory layouts with the current codebase state.

About

The update-readme skill ensures that repository documentation never falls out of sync with the underlying codebase. It specializes in maintaining a single, high-quality top-level README by consolidating fragmented documentation, removing obsolete instructions, and automatically generating copy-pasteable setup commands. By specifically targeting Nix directory layouts and active configuration roots like Neovim, WezTerm, and Zsh, it provides developers with a streamlined, accurate entry point for their projects while enforcing a clean, single-file documentation structure.

Key Features

Generation of executable, copy-pasteable setup commands
Validation of active configuration roots like Git, Neovim, and Zsh
Structural mapping for Nix directory layouts
0 GitHub stars
Automated README consolidation into a single root file
Proactive removal of deprecated or unsubstantiated content

Use Cases

Consolidating fragmented documentation from multiple subdirectories into a clean root README
Removing outdated badges and broken links to ensure documentation accuracy
Refreshing setup instructions after a major repository refactor or Nix migration

About

Key Features

Generation of executable, copy-pasteable setup commands
Validation of active configuration roots like Git, Neovim, and Zsh
Structural mapping for Nix directory layouts
0 GitHub stars
Automated README consolidation into a single root file
Proactive removal of deprecated or unsubstantiated content

Use Cases

Consolidating fragmented documentation from multiple subdirectories into a clean root README
Removing outdated badges and broken links to ensure documentation accuracy
Refreshing setup instructions after a major repository refactor or Nix migration