Artefact introduction
Skill JasonWarrenUK/goblin-mode/skills/artefact-introduction
{{ πππ }} Render a visual HTML introduction to this codebase for a newly-joined developerFrom its SKILL.md
npx -y skills add JasonWarrenUK/goblin-mode --skill artefact-introductionAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
2 things to look at
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
- 5 stars5 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
1.6 KB, 275 tokens by cl100k_base, as published. Nobody here has run it
Repo Introduction
<overview> Produce an interactive visual overview of this codebase aimed at a newly-joined developer. Uses the visual-explainer plugin to generate a standalone HTML page with architecture diagrams, module relationships, and project context. </overview> <steps> 1. Load the visual-explainer skill. 2. Analyse the codebase: - Read README.md, package.json/go.mod/Cargo.toml/pyproject.toml for identity and dependencies - Map top-level directory structure and entry points - Read key source files to understand module structure and public API surface - Skim git log for recent activity and key decisions 3. If $ARGUMENTS contains content, treat it as a focus area and weight the analysis accordingly. 4. Generate a visual HTML page following the visual-explainer workflow: - Architecture snapshot (Mermaid diagram of modules and their relationships) - Project identity: what it does, who uses it, what stage it's at - Mental model essentials: invariants, non-obvious coupling, naming conventions, gotchas - Module map with responsibilities 5. Write to ~/.agent/diagrams/ and open in browser. </steps> <inputs> $ARGUMENTS </inputs>What ships with it
Read from the repository
Just SKILL.md. No reference files, no scripts.