README.md

PowerShell Profile Documentation

Welcome to the PowerShell Profile documentation! This documentation is organized into several sections to help you find what you need.

Documentation Structure

📚 API Reference

Complete reference documentation for all functions and aliases available in the profile.

• Functions: Browse all functions organized by fragment
• Aliases: Browse all aliases organized by fragment
• Index: Full API index with functions and aliases grouped by source fragment

The API documentation is automatically generated from comment-based help in the profile functions and aliases.

🧩 Fragment Documentation

Documentation for each profile fragment, explaining what each fragment does and what functions it provides.

• Fragment Index: Browse all fragments organized by load order
• Individual Fragments: See detailed documentation for each fragment

Fragments are modular components of the profile, loaded in dependency-aware order (tier-based: core, essential, standard, optional). Many fragments use organized subdirectories for related modules:

• Main Fragments (00-99): Core fragments that load and orchestrate modules
• Module Subdirectories: Organized modules loaded by parent fragments
  • cli-modules/ - Modern CLI tool integrations
  • container-modules/ - Container helper modules
  • conversion-modules/ - Data/document/media format conversions
  • dev-tools-modules/ - Development tool integrations
  • diagnostics-modules/ - Diagnostic and monitoring modules
  • files-modules/ - File operation modules
  • git-modules/ - Git integration modules
  • utilities-modules/ - Utility function modules

📖 Developer Guides

Comprehensive guides for developers working on or contributing to the profile.

• Development Guide: DEVELOPMENT.md - Developer guide and advanced testing
• Type Safety Guide: TYPE_SAFETY.md - Improving type safety with enums, classes, and validation
• Type Safety Implementation: TYPE_SAFETY_IMPLEMENTATION_SUMMARY.md - Summary of implemented type safety improvements
• Type Safety Migration Status: TYPE_SAFETY_MIGRATION_STATUS.md - Current migration status from constants to enums
• Refactoring Opportunities: REFACTORING_OPPORTUNITIES.md - Identified refactoring opportunities and priorities
• Remaining Tasks: REMAINING_TASKS.md - Actionable items for ongoing maintenance and future work
• Function Naming Exceptions: FUNCTION_NAMING_EXCEPTIONS.md - Exceptions to standard naming conventions
• Security Allowlist: SECURITY_ALLOWLIST.md - Security scanning allowlist

Quick Links

• Main Profile README: PROFILE_README.md - Comprehensive profile documentation
• Architecture: ARCHITECTURE.md - Technical architecture details
• Contributing: CONTRIBUTING.md - How to contribute
• Agent Guidelines: AGENTS.md - Guidelines for AI coding assistants

Documentation Generation

All documentation is automatically generated from source code:

• API Documentation: Run task generate-docs or pwsh -NoProfile -File scripts/utils/docs/generate-docs.ps1
• Fragment Documentation: Run task generate-fragment-readmes or pwsh -NoProfile -File scripts/utils/docs/generate-fragment-readmes.ps1
• All Documentation: Run task all-docs to generate both

Statistics

• Total Functions: See API index for current count
• Total Aliases: See API index for current count
• Total Fragments: See Fragment index for current count

---

Last updated: 2025-01-XX