Files
The-Somnus-Project/architect-tasks.md

3.7 KiB

Task List: Refactor Architecture Documentation for Python/Textual TUI

Objective

Update all architecture and technical documentation to reflect the shift from Godot to a Python-based application using the Textual library for an ASCII/TUI interface.

Context

The project's UI/UX and high-level goals have been refactored to use Python and Textual for an ASCII experience. The underlying architecture documents still reference Godot and need to be updated to reflect this fundamental change.

Files to Update

Core Architecture Documents (docs/sharded-architecture/)

  • 1-introduction.md
  • 2-architectural-goals-and-constraints.md
  • 3-system-architecture.md
  • 4-scene-node-architecture-frontend.md (Rename to 4-frontend-architecture-tui.md or similar)
  • 5-scripting-game-logic-architecture-backend.md (Rename to 5-backend-logic-architecture.md or similar)
  • 6-data-persistence-architecture.md
  • 7-technology-stack.md
  • 8-performance-and-security.md
  • 9-development-and-deployment.md
  • coding-standards.md
  • unified-project-structure.md

PRD Technical Sections (docs/sharded-prd/)

  • 2-requirements.md
  • 4-technical-architecture-summary.md

Other Technical Documents

  • docs/testing-strategy.md

Specific Instructions for Each File

General

  1. Remove all references to Godot. This includes the technology stack, project structure, coding standards, and specific Godot classes/nodes (e.g., FileAccess, AutoLoad, CanvasLayer, Area2D).
  2. Replace Godot concepts with Python/Textual equivalents.
    • Godot Scenes/Nodes -> Python classes, Textual Widgets/Containers
    • GDScript -> Python
    • Godot Signals -> Python events/callbacks/Textual message system
    • Godot AutoLoads -> Python singletons/modules
    • Godot project structure -> Standard Python project layout (e.g., src/, tests/)
  3. Update the Technology Stack. Clearly define Python and Textual as the core technologies.
  4. Revise Architecture Descriptions. Rewrite sections describing the system, frontend, and backend architecture to be accurate for a Python application. The "scene-based model" concept from Godot should be replaced.
  5. Data Persistence. Update the data persistence strategy to use standard Python libraries (e.g., pickle, json, sqlite3) instead of Godot's store_var/get_var.
  6. Development & Deployment. Change build processes and deployment targets from Godot executables to Python package distribution (e.g., pip, standalone executable via pyinstaller).
  7. Coding Standards. Update to follow Python best practices (e.g., PEP 8) instead of GDScript guidelines.
  8. Project Structure. Redefine the directory structure to align with a standard Python project, not a Godot project.
  9. Performance & Security. Re-evaluate and rephrase these sections in the context of a Python application.
  10. Testing Strategy. Update to detail Python testing frameworks (e.g., unittest, pytest) and strategies for a TUI application.

Specific File Notes

  • 4-scene-node-architecture-frontend.md: This file's name and content are highly Godot-specific. It should be heavily revised or renamed and refocused on the TUI component architecture using Textual.
  • 5-scripting-game-logic-architecture-backend.md: This should be revised to describe the Python backend architecture.
  • 7-technology-stack.md: This is a key file to update, listing Python, Textual, and any other relevant libraries.
  • 2-requirements.md and 4-technical-architecture-summary.md: Ensure Non-Functional Requirements (NFRs) related to technology are updated.

Please ensure all changes are consistent with the new direction and the updated PRD/UI spec.