docs-sync-edho-ferdian

Generate codemaps and validate documentation freshness against the current codebase.

2|Updated Sep 6, 2026
One-click install
npx skills add https://github.com/edhoferdian/EEF --skill docs-sync-edho-ferdian-edhoferdian
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-sync-edho-ferdian
Source: https://github.com/edhoferdian/EEF/tree/main/.agents/skills/docs-sync-edho-ferdian
Command: npx skills add https://github.com/edhoferdian/EEF --skill docs-sync-edho-ferdian-edhoferdian

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? User-facing documentation drifts out of sync with the code it describes — READMEs reference deleted paths, links break, code snippets no longer compile, and codemaps go stale after features ship. This Skill keeps README, docs/CODEMAPS/*, architecture docs, and public API docs honest by generating what can be generated from source and flagging what has gone stale instead of silently rewriting it. ## Core Features & Use Cases - Codemap generation and refresh: Builds docs/CODEMAPS/ (INDEX.md plus one file per real area) from actual source files, with entry points, exports, routes, data flow, and freshness timestamps. - Doc-freshness validation: Verifies every path exists, every link resolves, every code snippet matches reality, and staleness is checked against timestamps and last-touching commits. - Salak-sourced dependency sections: Populates codemap dependency sections only from the Salak repo graph with provenance, or omits them honestly — never rebuilds a second dependency graph via madge or AST parsing. - Use Case: After shipping a new API feature, ask the Skill to sync the docs — it regenerates the affected codemaps, flags a stale README snippet, and reports exactly what changed and why. ## Quick Start Ask the assistant to sync the README and regenerate the codemaps for the feature that just shipped, then report which docs were stale.

Frequently Asked Questions about docs-sync-edho-ferdian

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

FAQPage Schema
How do I keep README and architecture docs in sync with my codebase?

Run a docs sync pass that regenerates codemaps from actual source files and validates freshness — checking that every documented path exists, every link resolves, and every code snippet matches the real code. Stale content is flagged with reasons rather than silently rewritten.

What is a codemap and how is it generated?

A codemap is a per-area architectural map under docs/CODEMAPS/ with an INDEX.md plus one file per real area (frontend, backend, database, integrations, workers). It is generated by reading actual source files to extract entry points, exports, routes, and data flow — never inferred from directory names alone.

Does this skill generate dependency graphs with madge or AST parsing?

No. Dependency sections are read only from the Salak repo graph (project-memory/repo-graph.json) with provenance levels. If Salak is not installed or its graph is stale, the dependency section is omitted entirely rather than approximated with grep or import scanning.

Can it update project-memory files like the decision register or progress log?

No. Files under /project-memory/ are explicitly out of scope — they belong to the dev-kickoff skill's REMEMBER stage as an internal execution ledger. This skill only touches user-facing documentation such as README, public docs, and codemaps.

When should codemaps be regenerated versus left alone?

Regenerate when a major feature ships, API routes change, dependencies are added or removed, or architecture changes. Skip regeneration for minor bug fixes, cosmetic changes, or internal refactors that do not alter public surfaces, routes, or dependencies.