Skip to content

docs: Expand mechanics documentation and add logging infrastructure (Issues #465, #464)#496

Merged
PipFoweraker merged 2 commits intomainfrom
feature/docs-automation
Dec 24, 2025
Merged

docs: Expand mechanics documentation and add logging infrastructure (Issues #465, #464)#496
PipFoweraker merged 2 commits intomainfrom
feature/docs-automation

Conversation

@PipFoweraker
Copy link
Owner

@PipFoweraker PipFoweraker commented Dec 19, 2025

Summary

Issue #465: Mechanics Documentation

  • Add docs/mechanics/funding.md - fundraising, investors, money sinks, compute
  • Add docs/mechanics/doom.md - P(Doom) mechanics, momentum system, doom sources
  • Add docs/mechanics/personnel.md - hiring, specializations, traits, burnout
  • Update docs/mechanics/README.md - fix status table, victory/loss conditions
  • Regenerate data cache via generate_mechanics_docs.py

Issue #464: Build Logging Infrastructure

  • Create logs/ directory structure with categorized subdirectories (quality, release, testing, docs, dev)
  • Add logs/README.md documenting the logging system, file naming conventions, and retention policies
  • Update .gitignore to preserve logs/README.md and .gitkeep files
  • Add "Logging System" section to scripts/README.md with quick start examples

Details

All mechanics documentation values extracted from game source code (game_state.gd, doom_system.gd, researcher.gd, actions.gd). Documentation follows the existing reputation.md pattern with auto-generated game data tables.

The existing logging_system.py provides a PDoomLogger class with structured JSON output, timed operations, and log categories. This PR adds the directory structure and documentation.

Test plan

  • All markdown renders correctly
  • Links to source files are valid (relative paths)
  • Auto-generated data tables match game values
  • README status table updated to reflect new docs
  • Verify logs/ directory structure created correctly
  • Confirm .gitignore preserves README and .gitkeep files

Closes #465
Closes #464

🤖 Generated with Claude Code

PipFoweraker and others added 2 commits December 19, 2025 15:27
…465)

Create Priority 1 mechanics documentation:
- docs/mechanics/funding.md - Starting resources, fundraising options, costs
- docs/mechanics/doom.md - P(Doom) mechanics, momentum system, sources
- docs/mechanics/personnel.md - Hiring, specializations, traits, burnout

Updates:
- README.md - Updated status table, fixed victory/loss conditions
- reputation.md - Regenerated with updated game data
- .mechanics_data.json - Updated data cache

All values extracted from godot/scripts/core/game_state.gd and related
game files. Documentation follows the existing reputation.md pattern
with auto-generated game data tables.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
- Create logs/ directory structure with subdirectories:
  - logs/quality/ for pre-commit hooks and linting
  - logs/release/ for build and version operations
  - logs/testing/ for test runs and validation
  - logs/docs/ for documentation generation
  - logs/dev/ for general development logs
- Add logs/README.md documenting the logging system
- Update .gitignore to preserve logs/README.md and .gitkeep files
- Add logging documentation section to scripts/README.md

The existing logging_system.py provides PDoomLogger class with
structured JSON output, timed operations, and log categories.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@PipFoweraker PipFoweraker changed the title docs: Expand mechanics documentation (Issue #465) docs: Expand mechanics documentation and add logging infrastructure (Issues #465, #464) Dec 24, 2025
@PipFoweraker PipFoweraker merged commit 5645186 into main Dec 24, 2025
20 of 21 checks passed
@PipFoweraker PipFoweraker deleted the feature/docs-automation branch December 24, 2025 03:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Expand mechanics documentation coverage Add comprehensive build logging system with persistent .txt file records

1 participant