Update README and CLAUDE.md

README: replace placeholder with full project overview — usage,
skill setup (UE_DOCS_PATH/UE_ENGINE_ROOT env vars), sample files,
output format reference.

CLAUDE.md: drop "in development" (project is complete), add
.claude/skills/ue-api/ to the current state file list.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
2026-02-24 06:57:16 -05:00
parent 93ca33c36a
commit 904277e9e5
2 changed files with 59 additions and 3 deletions

View File

@@ -4,7 +4,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
## Project Purpose
UnrealDocGenerator is a tool (in development) for generating documentation from Unreal Engine C++ header files. The `samples/` directory contains representative Unreal Engine headers used as test inputs:
UnrealDocGenerator is a tool for generating documentation from Unreal Engine C++ header files. The `samples/` directory contains representative Unreal Engine headers used as test inputs:
- `samples/GeomUtils.h` — Small utility header (~6 KB): geometry/math helpers in `UE::AI` namespace
- `samples/AIController.h` — Medium header (~22 KB): `AAIController` class with movement, behavior tree, perception, and blackboard integration
@@ -14,10 +14,11 @@ These samples cover a range of complexity (free functions, large classes, deeply
## Current State
Implementation complete. Three Python files:
Implementation complete. Three Python files + a Claude Code skill:
- `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)
- `.claude/skills/ue-api/SKILL.md` — Claude Code skill; queries docs via `$UE_DOCS_PATH`, falls back to `$UE_ENGINE_ROOT` source headers
## Usage