repo-wayfinder

Solid

Wayfind repository documentation by tracing real tasks to code-owned authority. Use when the user wants to audit scattered, stale, duplicated, or mixed-role docs; decide whether README, AGENTS.md, architecture, runbook, or protocol documents should exist and where they belong; or apply an accepted documentation-topology repair.

AI & Automation 2 stars 0 forks Updated today MIT

Install

View on GitHub

Quality Score: 78/100

Stars 20%
16
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Repo Wayfinder Treat documentation as a **wayfinder**, not proof. A wayfinder earns its place by helping a task reach the source that owns the answer. Current behavior usually belongs to code, types, schemas, configuration, or another executable contract. Tests and driven probes verify that owner; they do not become a second owner. Default to a read-only diagnosis. Enter the apply branch only when the user explicitly asks to change files. ## 1. Pin the observation Read every applicable instruction file before judging the repository. Record: - repository root, branch, exact commit, and dirty paths; - the user-selected scope; - package or service boundaries; - the instruction chain that applies to each scoped directory. Preserve unrelated work. Treat an uncommitted tree as observable state, not as a reason to clean it. **Complete when:** the audit names the exact state and scope it is describing. ## 2. Inventory authority Use fast repository-native discovery such as `rg --files` and `git ls-files`. Include root and nested instruction files, READMEs, `docs/`, runbooks, protocol documents, decisions, proposals, measurements, generated references, and issue templates in scope. Assign every discovered document a primary role: - routing or agent instruction; - current contract; - operational runbook; - measurement or evidence; - decision or history; - proposal or bet; - generated reference; - unclassified. For each document, identify its **owning question**, audience, ...

Details

Author
Wang-Cankun
Repository
Wang-Cankun/cankun-skills
Created
1 weeks ago
Last Updated
today
Language
JavaScript
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category