docs

Documentation

Overview

Package docs provides documentation generation functionality for Nix Foundry. It generates various documentation files including installation guides, package documentation, and troubleshooting guides.

Index

• func GenerateInstallGuide() (string, error)
• func GeneratePackageGuide() (string, error)
• func GeneratePackageList() string
• func GeneratePlatformList() string
• func GenerateTroubleshootingGuide() (string, error)
• func GenerateUninstallGuide() (string, error)

Functions

func GenerateInstallGuide

func GenerateInstallGuide() (string, error)

GenerateInstallGuide generates the installation guide. It creates comprehensive documentation for installing Nix Foundry on different platforms.

func GeneratePackageGuide

func GeneratePackageGuide() (string, error)

GeneratePackageGuide generates the package management guide. It documents available packages, their descriptions, and usage instructions.

func GeneratePackageList

func GeneratePackageList() string

GeneratePackageList generates a markdown list of available packages. It organizes packages by category and includes descriptions.

func GeneratePlatformList

func GeneratePlatformList() string

GeneratePlatformList generates a markdown list of supported platforms. It includes platform-specific information and requirements.

func GenerateTroubleshootingGuide

func GenerateTroubleshootingGuide() (string, error)

GenerateTroubleshootingGuide generates the troubleshooting guide. It provides solutions for common issues and debugging steps.

func GenerateUninstallGuide

func GenerateUninstallGuide() (string, error)

GenerateUninstallGuide generates the uninstallation guide. It provides instructions for removing Nix Foundry and its components.