Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
445 changes: 445 additions & 0 deletions optional-skills/software-development/code-wiki/SKILL.md

Large diffs are not rendered by default.

31 changes: 31 additions & 0 deletions optional-skills/software-development/code-wiki/templates/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# {{PROJECT_NAME}}

{{ONE_PARAGRAPH_DESCRIPTION}}

## Key Concepts

- **{{CONCEPT_1}}** — {{ONE_LINE}}
- **{{CONCEPT_2}}** — {{ONE_LINE}}
- **{{CONCEPT_3}}** — {{ONE_LINE}}

## Entry Points

- [`{{PATH_1}}`]({{LINK_1}}) — {{WHAT_IT_DOES}}
- [`{{PATH_2}}`]({{LINK_2}}) — {{WHAT_IT_DOES}}

## High-Level Architecture

{{TWO_TO_THREE_SENTENCES}}

See [architecture.md](architecture.md) for the full picture.

## Module Map

| Module | Purpose |
|---|---|
| [`{{MODULE_1}}`](modules/{{MODULE_1}}.md) | {{ONE_LINE_PURPOSE}} |
| [`{{MODULE_2}}`](modules/{{MODULE_2}}.md) | {{ONE_LINE_PURPOSE}} |

## Getting Started

See [getting-started.md](getting-started.md).
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Architecture

{{TWO_TO_THREE_PARAGRAPHS_SHAPE_OF_SYSTEM}}

## Components

- **{{COMPONENT_1}}** — {{ONE_TO_TWO_SENTENCES}} See [`modules/{{MODULE}}.md`](modules/{{MODULE}}.md).
- **{{COMPONENT_2}}** — {{ONE_TO_TWO_SENTENCES}}

## System Diagram

```mermaid
flowchart TD
User([User]) --> Entry[Entry Point]
Entry --> Core[Core Engine]
Core --> StorageA[(Database)]
Core --> ExternalAPI{{External API}}
```

## Data Flow

1. **{{STEP_1}}** — [`{{FILE}}`]({{LINK}})
2. **{{STEP_2}}** — [`{{FILE}}`]({{LINK}})
3. **{{STEP_3}}** — [`{{FILE}}`]({{LINK}})

## Key Design Decisions

- {{DECISION_1}}
- {{DECISION_2}}
- {{DECISION_3}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Getting Started

## Prerequisites

- {{LANGUAGE_RUNTIME_VERSION}}
- {{DEPENDENCY}}

## Installation

```bash
{{INSTALL_COMMANDS}}
```

## First Run

```bash
{{FIRST_RUN_COMMAND}}
```

You should see {{EXPECTED_OUTPUT}}.

## Common Workflows

### {{WORKFLOW_1}}

```bash
{{COMMANDS}}
```

### {{WORKFLOW_2}}

```bash
{{COMMANDS}}
```

## Configuration

Key config files and settings:

- `{{CONFIG_FILE}}` — {{WHAT_IT_CONTROLS}}
- Env var `{{VAR}}` — {{WHAT_IT_CONTROLS}}

## Where to Go Next

- Architecture overview: [architecture.md](architecture.md)
- Module reference: [README.md#module-map](README.md#module-map)
- Diagrams: [diagrams/](diagrams/)
38 changes: 38 additions & 0 deletions optional-skills/software-development/code-wiki/templates/module.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Module: `{{MODULE_NAME}}`

{{ONE_TO_TWO_SENTENCE_PURPOSE}}

## Responsibilities

- {{BULLET_1}}
- {{BULLET_2}}
- {{BULLET_3}}

## Key Files

- [`{{PATH_1}}`]({{LINK_1}}) — {{WHAT_IT_DOES}}
- [`{{PATH_2}}`]({{LINK_2}}) — {{WHAT_IT_DOES}}

## Public API

### `{{FUNCTION_NAME}}({{SIGNATURE}})`

{{ONE_LINE_DESCRIPTION}}

**Parameters:**
- `{{PARAM}}` ({{TYPE}}) — {{DESCRIPTION}}

**Returns:** {{TYPE}} — {{DESCRIPTION}}

## Internal Structure

{{HOW_THE_MODULE_IS_ORGANIZED}}

## Dependencies

- **Used by:** {{OTHER_MODULES}}
- **Uses:** {{OTHER_MODULES_AND_LIBS}}

## Notable Patterns / Gotchas

- {{ANYTHING_NON_OBVIOUS}}
1 change: 1 addition & 0 deletions website/docs/reference/optional-skills-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,7 @@ hermes skills uninstall <skill-name>

| Skill | Description |
|-------|-------------|
| [**code-wiki**](/user-guide/skills/optional/software-development/software-development-code-wiki) | Generate wiki docs + Mermaid diagrams for any codebase. |
| [**rest-graphql-debug**](/user-guide/skills/optional/software-development/software-development-rest-graphql-debug) | Debug REST/GraphQL APIs: status codes, auth, schemas, repro. |

## web-development
Expand Down
Loading
Loading