Move scripts to docgen/, remove possess_flow.png
- docgen/: generate.py, ue_parser.py, ue_markdown.py, ue_mcp_server.py - .mcp.json: update server path to docgen/ue_mcp_server.py - Update CLAUDE.md and README paths accordingly Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
18
CLAUDE.md
18
CLAUDE.md
@@ -8,20 +8,20 @@ UnrealDocGenerator is a tool for generating documentation from Unreal Engine C++
|
||||
|
||||
## Current State
|
||||
|
||||
Implementation complete. Four Python files + MCP registration:
|
||||
- `ue_parser.py` — Parses UE headers into dataclasses
|
||||
- `ue_markdown.py` — Renders parsed data as Markdown (ultra-compact format, documented items only)
|
||||
- `generate.py` — CLI entry point; two-pass pipeline (parse-all → build type index → render-all)
|
||||
- `ue_mcp_server.py` — MCP server exposing 5 tools for item-granularity doc lookups
|
||||
Implementation complete. Scripts live in `docgen/`:
|
||||
- `docgen/ue_parser.py` — Parses UE headers into dataclasses
|
||||
- `docgen/ue_markdown.py` — Renders parsed data as Markdown (ultra-compact format, documented items only)
|
||||
- `docgen/generate.py` — CLI entry point; two-pass pipeline (parse-all → build type index → render-all)
|
||||
- `docgen/ue_mcp_server.py` — MCP server exposing 5 tools for item-granularity doc lookups
|
||||
- `.mcp.json` — Registers the MCP server with Claude Code (stdio transport)
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
python generate.py <input> [input2 ...] <output_dir>
|
||||
python docgen/generate.py <input> [input2 ...] <output_dir>
|
||||
|
||||
python generate.py Runtime/Engine/ Runtime/AIModule/ docs/ # multiple directories
|
||||
python generate.py Runtime/Engine/Classes/GameFramework/Actor.h docs/ # single file
|
||||
python docgen/generate.py Runtime/Engine/ Runtime/AIModule/ docs/ # multiple directories
|
||||
python docgen/generate.py Runtime/Engine/Classes/GameFramework/Actor.h docs/ # single file
|
||||
```
|
||||
|
||||
Output: one `.md` per `.h` + `docs/type-index.txt` (compact `TypeName: path/to/File.md` lookup).
|
||||
@@ -30,7 +30,7 @@ The last argument is always the output directory. All preceding arguments are in
|
||||
|
||||
## MCP Server
|
||||
|
||||
`ue_mcp_server.py` exposes 5 tools Claude can call directly:
|
||||
`docgen/ue_mcp_server.py` exposes 5 tools Claude can call directly:
|
||||
|
||||
| Tool | Purpose |
|
||||
|---|---|
|
||||
|
||||
Reference in New Issue
Block a user