Skip to content

Docs Run

osa_tool.operations.docs.community_docs_generation.docs_run

generate_documentation(config_manager, metadata)

This function initializes builders for various documentation templates such as contribution guidelines, community standards, and issue templates. It sequentially generates these files based on the loaded configuration.

Parameters:

Name Type Description Default
config_manager ConfigManager

A unified configuration manager that provides task-specific LLM settings, repository information, and workflow preferences.

required
metadata RepositoryMetadata

Git repository metadata.

required

Returns:

Name Type Description
dict dict

Standardized operation output containing: - result: Generated documentation summary - events: List of OperationEvent