src.integrations.documentation_tasks module#

Documentation Task Generation for Marcus.

Adds a final documentation task to projects that: 1. Reviews all logged decisions 2. Creates comprehensive README.md 3. Verifies all instructions work

class src.integrations.documentation_tasks.DocumentationTaskGenerator[source]#

Bases: object

Generates documentation tasks for projects.

static create_documentation_task(existing_tasks, project_name='Project')[source]#

Create a final documentation task.

Depends on all major implementation tasks.

Parameters:

  • existing_tasks (List[Task]) – List of all project tasks

  • project_name (str) – Name of the project

Returns:

Documentation task or None if no implementation tasks exist

Return type:

Optional[Task]

static should_add_documentation_task(project_description, task_count)[source]#

Determine if a documentation task should be added.

Parameters:

  • project_description (str) – Natural language description

  • task_count (int) – Number of tasks in project

Returns:

True if documentation should be added

Return type:

bool

src.integrations.documentation_tasks.enhance_project_with_documentation(tasks, project_description, project_name='Project')[source]#

Add documentation task to project if appropriate.

Parameters:

  • tasks (List[Task]) – Original project tasks

  • project_description (str) – Project description

  • project_name (str) – Name of the project

Returns:

Task list with documentation task added if appropriate

Return type:

List[Task]