skills.rest
streamlit
streamlitOFFICIAL
Explore all skills by this author →
WebsiteGitHub

updating-internal-docs

Review internal Markdown documentation against the codebase and propose fixes for outdated content.

45.7k|4.4k|Updated Aug 24, 2019
Search Tags:#Markdown#streamlit#Technical Writing#Documentation#documentation drift#Code review#Repository Maintenance
One-click install
npx skills add https://github.com/streamlit/streamlit --skill updating-internal-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: updating-internal-docs
Source: https://github.com/streamlit/streamlit/tree/main/.claude/skills/updating-internal-docs
Command: npx skills add https://github.com/streamlit/streamlit --skill updating-internal-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Internal documentation drifts out of sync with the codebase as features, commands, and file paths change, leaving developers with incorrect instructions. This Skill systematically audits Markdown documentation against the actual repository state and proposes verified corrections.

Core Features & Use Cases

  • Documentation Drift Detection: Cross-references documented commands, paths, versions, and links against the actual codebase to find outdated, incorrect, or missing information.
  • Structured Issue Reporting: Classifies findings by type (OUTDATED, INCORRECT, VERSION_MISMATCH, MISSING, BROKEN_LINK, INCONSISTENT) with file and line references before applying fixes.
  • Bundled Skill Sync: Checks whether Streamlit feature changes require updates to bundled skills under lib/streamlit/.agents/skills/.
  • Use Case: After merging a PR that renames a make target, run this Skill to find every AGENTS.md, README, and wiki page still referencing the old command and fix them in one pass.

Quick Start

Review the repository's internal documentation for outdated information and propose fixes for any issues you find.

Frequently Asked Questions about updating-internal-docs

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

FAQPage Schema
How do I find outdated documentation in a repository?▼

Enumerate all Markdown files, then cross-reference documented commands, paths, and versions against the actual codebase. This Skill automates that audit and reports each issue with its file, line, current text, and verified correction.

How to keep developer docs in sync with code changes?▼

Run a documentation review after significant codebase changes such as new features, refactors, or tooling updates. The Skill checks make targets, folder structure, dependencies, and workflows, then proposes minimal verified fixes.

What types of documentation issues can be detected?▼

The Skill classifies findings as OUTDATED, INCORRECT, VERSION_MISMATCH, MISSING, BROKEN_LINK, or INCONSISTENT. Each issue is reported with the documented claim and the verified actual state before any fix is applied.

Does it update documentation automatically without approval?▼

No. The Skill presents all findings grouped by priority and waits for the user to choose which issues to fix. Changes are applied incrementally only after approval, keeping edits minimal and consistent with existing style.

Which files are checked during a documentation review?▼

Priority files include AGENTS.md, README.md, CONTRIBUTING.md, wiki pages, and SKILL.md definitions. Synced generated copies like .github/copilot-instructions.md are skipped since they are updated through a separate generation script.

Related Skills

Explore More Software Engineering Skills→
tachiiri-orgtachiiri-org

release

Create a pull request from the dev branch to main after verifying branch and remote state.

Official
Intermediate
nizarghribinizarghribi

commit-protocol

Run pnpm lint and type-check in parallel before requiring explicit user approval for git commits.

Community
Basic
devantler-techdevantler-tech
2

agent-instructions

Architect a canonical AGENTS.md with tool-specific shims for Claude, Copilot, Cursor, Gemini, and Codex.

Official
Advanced
joyz0joyz0

update-docs

Map code diffs to Next.js documentation pages and validate MDX updates.

Community
Intermediate