Struct GitHubDocsDownloader

pub struct GitHubDocsDownloader { /* private fields */ }

Documentation downloader using git clone approach.

This downloader fetches documentation files by cloning the repository with git. It automatically discovers documentation directories and filters files based on common documentation patterns.

Implementations

impl GitHubDocsDownloader

pub fn new(repo: RepoSpec, config: DownloadConfig) -> Self

Create a new documentation downloader.

Arguments

• repo - Repository specification (owner/name)
• config - Download configuration

pub fn find_docs_directories(&self) -> Result<Vec<DocsDirectory>>

Discover all documentation directories in the repository.

Errors

Returns GitHubDocsError if directory discovery fails.

pub fn get_all_documentation_files( &self, docs_dirs: &[DocsDirectory], ) -> Result<Vec<DocumentationFile>>

Get all documentation files from the specified directories.

Arguments

• docs_dirs - Directories to scan for documentation files

Errors

Returns GitHubDocsError if file discovery fails.

pub fn download_files(&self, files: &[DocumentationFile]) -> Result<()>

Show download summary for files.

Arguments

• files - Documentation files that were processed

Errors

This function does not return errors in the current implementation.

pub fn repo(&self) -> &RepoSpec

Get the repository specification.