Add comprehensive documentation and Claude Code integration#20
Open
JohnVonDrashek wants to merge 17 commits intoaudinowho:masterfrom
Open
Add comprehensive documentation and Claude Code integration#20JohnVonDrashek wants to merge 17 commits intoaudinowho:masterfrom
JohnVonDrashek wants to merge 17 commits intoaudinowho:masterfrom
Conversation
- Add 33 README.md files covering all project directories - Include CLAUDE.md for AI-assisted development context - Core library: architecture diagrams, API references, usage examples - Examples: tutorial-style walkthroughs for Ex1-Ex8 progression - Tests: testing patterns, how to add tests, coverage details - Cross-references between related folders - Mermaid diagrams for complex architecture - Code snippets from actual source files 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add shields.io badges (NuGet, License, .NET Standard) - Add Features section highlighting key capabilities - Add Quick Start with installation and code example - Add Core Classes and Generation Steps tables - Add Layout Modes section with ASCII diagram - Add Documentation section linking to folder READMEs - Add Integration Examples section - Improve overall formatting and readability 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Documents 165 C# files in the core library with comprehensive XML documentation including <summary>, <param>, <returns>, <typeparam>, <remarks>, and <see cref> tags. Documentation depth varies by importance: comprehensive for core abstractions (MapGen, GenStep, FloorPlan, GridPlan), standard for module classes, minimal for simple utilities. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- architecture.md: Interface hierarchy diagrams, GenStep categories, data flow - flows.md: Traced code paths for MapGen, GridPath, room generation, spawning - patterns.md: Step-by-step recipes for custom rooms, steps, spawnables, contexts - Updated CLAUDE.md to reference the new documentation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
…entation" This reverts commit 3d447b1.
Created using codebase-documenter skill with thorough exploration: - architecture.md: Interface hierarchy diagrams, GenStep categories, data flow - flows.md: Traced code paths with file:line references for MapGen, GridPath, room generation, spawning - patterns.md: Step-by-step recipes for custom rooms, steps, spawnables, contexts, game engine integration - Updated CLAUDE.md to reference the new documentation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Comprehensive documentation for all 8 examples + Common utilities: - Common/: Full XML docs on reusable components (contexts, tiles, spawnables) - Ex1_Tiles: MapGen, GenStep, Priority basics with inline teaching comments - Ex2_Rooms: FloorPlan, room generators, SpawnList concepts - Ex3_Grid: GridPlan, grid→floor→tile conversion pipeline - Ex4_Stairs: IPlaceableGenContext<T>, entity spawning system - Ex5_Terrain: PerlinWaterStep, terrain generation concepts - Ex6_Items: ISpawnable, weighted spawn tables, multiple entity types - Ex7_Special: RoomComponents, special room filtering - Ex8_Integration: Full pipeline reference with cross-example links - Program.cs, ExampleDebug.cs: Minimal utility documentation Style: XML docs on public APIs + concept-based inline comments (heavy on new concepts, light on repetition) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Provides documentation resources, prompts, and code generation tools for working with RogueElements in Claude Code. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add RogueElements.Benchmarks project with BenchmarkDotNet 0.14.0 - Include benchmarks for map generation (small/medium/large grids) - Include benchmarks for room generation (square/round/cave) - Include benchmarks for RNG operations - Update .gitignore to exclude BenchmarkDotNet.Artifacts/ 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add CollisionBenchmarks for FloorPlan collision detection scaling - Add SpawnBenchmarks comparing RemoveAt vs SwapPop (21% faster) - Add FloorPlanBenchmarks for room erasure and drawing - Add GridPlanBenchmarks for adjacency lookups and conversions - Add SUGGESTIONS.md documenting optimization opportunities - Update Program.cs to run new benchmark classes Baseline results show current performance is excellent (~0.5ms for 80-room maps). Suggestions documented for future scaling needs. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Port PMDC's MCP architecture to RogueElements: - Add web-tree-sitter and tree-sitter-c-sharp for AST parsing - Implement rogue_search for fuzzy class search across categories - Implement rogue_list_classes for listing classes by category - Implement rogue_get_class_docs for full XML documentation extraction - Define 12 class categories covering all library components - Add struct parsing support alongside classes and interfaces Also adds XML documentation to spawning interfaces. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Fix interface member extraction: C# interface members are implicitly
public and don't have explicit 'public' modifiers. Initialize propPublic
and methodPublic to isInterface value instead of false.
- Fix generic parameter truncation: Remove .split(",")[0] that was
incorrectly truncating base class names like BaseSpawnStep<TGenContext,
TSpawnable> to BaseSpawnStep<TGenContext. Now preserves full type name
and strips generics only for interface detection.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
v2.2.1 improvements: - Add constructor extraction with parameter documentation from <param> tags - Add related classes section showing siblings by base class, interface, or naming - Fix method return type extraction using multiple tree-sitter field names - Add rogue_get_docs tool for AI-optimized documentation access - Add rogue_get_example tool for annotated example retrieval - Add rogue_scaffold_spawnable tool for entity spawning boilerplate - Add pagination (limit/offset) to rogue_list_classes - Add response_format parameter (markdown/json) to discovery tools - Enhanced search scoring with property/method name matching Bug fixes: - Fix scaffold Step suffix duplication (LavaRiverStep no longer becomes LavaRiverStepStep) - Fix MapGen class not indexed (added MapGen dir to core category) - Fix pluralization issue in spawn scaffold template 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Document all 9 tools (search, list_classes, get_class_docs, etc.) - Add class categories table (12 categories) - Add documentation resources and examples tables - Include detailed usage examples for each tool - Add architecture diagram showing data flow 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Establish clear expectations for contributors: guaranteed feedback on all PRs/issues, welcoming stance on bug fixes and new features, and direct contact information for maintainer communication. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/claude/with detailed architecture, code flows, and patterns documentation optimized for LLM consumptionTest plan
dotnet build RogueElements.slndotnet test RogueElements.Tests/RogueElements.Tests.csprojdotnet run --project RogueElements.Examples/RogueElements.Examples.csprojcd mcp-server && npm install && npm run buildTL;DR
Contributions are much easier because we have more extensive documentation. Also, added MCP for Claude use. This is a small project, with likely no training data built into Claude so to make it usable we need an MCP so Claude can make quick queries to figure things out.
🤖 Generated with Claude Code mostly. Edited by human