search

edz314 / GenuineNarrativeCreator

The project aims to create a system that generates genuine narratives within a text-based RPG game. The core idea is to move beyond simple random text generation and create narratives that feel more natural and engaging for the player.
1 stars 0 forks source link

Update Documentation #28

Closed edz314 closed 4 weeks ago

edz314 commented 4 weeks ago

Observation:

Documentation has not kept pace with recent code changes, leading to inconsistencies and outdated information.

Proposed Action:

  1. Perform a full audit of the existing documentation to identify outdated sections.
  2. Update the documentation for all modules, particularly focusing on new features and changes to the API.
  3. Include examples and detailed guides for integrating the system into different game environments.
  4. Ensure that all public-facing APIs are well-documented, with clear explanations of input parameters, outputs, and usage scenarios.

Issue Example: Title: Comprehensive Update of Documentation for All Modules

Description:

  1. Audit and update all documentation, including API docs and module-specific guides.
  2. Focus on ensuring that all new features and code changes are accurately reflected in the documentation.
  3. Include usage examples and integration guides to assist developers in adopting the system.
edz314 commented 4 weeks ago

Current Status: The issue is about improving basic documentation.

Suggested Edit: Expand this to a comprehensive overhaul of documentation, including detailed descriptions of how the system integrates with game engines, how it aligns with RTNA goals, and examples of best practices for developers.

edz314 commented 4 weeks ago

closed with latest documents/architecture updates