doc-files

Generates Ukrainian Markdown documentation for code files with CRC-based staleness detection.

Updated Jun 25, 2026
One-click install
npx skills add https://github.com/nitra/7n-test --skill doc-files-nitra
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-files
Source: https://github.com/nitra/7n-test/tree/main/.cursor/skills/n-doc-files
Command: npx skills add https://github.com/nitra/7n-test --skill doc-files-nitra

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires @7n/rules.

What problem does it solve? Code documentation drifts out of sync with source files because developers forget to update it. This Skill keeps per-file Markdown docs current by detecting staleness deterministically via CRC checksums and regenerating outdated docs automatically. ## Core Features & Use Cases - CRC-based staleness detection: Each generated doc stores a checksum of its source file in frontmatter; a doc is stale when the current source CRC differs. - JS-orchestrated local pipeline: Queueing, batching, LLM calls, and CRC stamping run in a local JS orchestrator via npx @7n/rules lint doc-files, using a local model with no cloud escalation. - Degraded-mode handling: Docs scoring below the quality threshold are still written with a degraded marker and fresh CRC, so the pipeline never blocks. - Use Case: After modifying several TypeScript files in a repository, run the linter in fix mode to regenerate only the stale docs into docs/ folders next to the code, then review the summary of OK, degraded, and failed files. ## Quick Start Run the doc-files linter from the repository root to regenerate all stale or missing file documentation.

Frequently Asked Questions about doc-files

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

FAQPage Schema
How do I keep code documentation in sync with source files?

Run npx @7n/rules lint doc-files from the repository root. It compares the CRC of each source file against the CRC stored in its doc's frontmatter and regenerates only stale or missing docs.

How does CRC-based documentation staleness detection work?

Each generated doc stores a checksum of the source file's bytes in its docgen frontmatter. A doc is considered stale when the current source CRC differs from the stored value, making detection fully deterministic.

Which file types are supported for automatic documentation generation?

The scanner covers js, mjs, ts, vue, and py files. It ignores node_modules, dist, .git, __pycache__, coverage, docs folders, and test or declaration files like *.test.*, *.spec.*, and *.d.ts.

Does doc generation require a cloud LLM API?

No, the pipeline is local-only and generates every file with a local model. If the quality score falls below the threshold, the doc is still written with a degraded marker and fresh CRC rather than failing.

Why does the doc-files command fail with exit code 1?

Exit code 1 means at least one file failed to generate or the preflight check failed, such as the local model server being down or insufficient memory. The summary lists the problematic files for review.