Skip to content

DOCUMENTATION_INDEX.md

Latest commit

 

History

History
154 lines (111 loc) · 8.64 KB

DOCUMENTATION_INDEX.md

File metadata and controls

154 lines (111 loc) · 8.64 KB

ColorScripts-Enhanced Documentation Index

Complete guide to all documentation files in this repository.

Quick Links

User Documentation

Installation & Setup

Document Description
README.md Main project documentation with installation, usage, and examples
ColorScripts-Enhanced/README.md Module-specific documentation (identical to main README)
QUICK_REFERENCE.md Command reference and common usage patterns

Command Help

All commands have detailed help documentation in ColorScripts-Enhanced/en-US/:

Command Help File
Show-ColorScript Show-ColorScript.md
Get-ColorScriptList Get-ColorScriptList.md
New-ColorScriptCache New-ColorScriptCache.md
Clear-ColorScriptCache Clear-ColorScriptCache.md
Add-ColorScriptProfile Add-ColorScriptProfile.md
Get-ColorScriptConfiguration Get-ColorScriptConfiguration.md
Set-ColorScriptConfiguration Set-ColorScriptConfiguration.md
Reset-ColorScriptConfiguration Reset-ColorScriptConfiguration.md
Export-ColorScriptMetadata Export-ColorScriptMetadata.md
New-ColorScript New-ColorScript.md

Module Help: about_ColorScripts-Enhanced.help.txt

Technical Guides

Document Description
ANSI-COLOR-GUIDE.md ANSI escape codes reference and color palette guide
ANSI-CONVERSION-GUIDE.md Converting ANSI art files to PowerShell colorscripts
POWERSHELL-VERSIONS.md PowerShell version compatibility matrix

Developer Documentation

Development Workflow

Document Description
DEVELOPMENT.md Local development setup, tooling, and workflows
TESTING.md Testing procedures and test suite documentation
LINTING.md Code quality standards and linting guide
NPM_SCRIPTS.md Reference for all npm scripts available
MODULE_SUMMARY.md Complete module implementation overview
CONTRIBUTING.md How to contribute code, scripts, and documentation

Release & Publishing

Document Description
PUBLISHING.md Publishing to PowerShell Gallery, NuGet.org, and GitHub Packages
RELEASE_CHECKLIST.md Step-by-step release checklist with git-cliff integration
CHANGELOG.md Complete project changelog

Project Management

Document Description
ROADMAP.md Project roadmap and planned features
SUPPORT.md Support channels and response time expectations
CONTRIBUTORS.md List of project contributors
todo.md Development tasks and action items

Repository Policies

Document Description
CODE_OF_CONDUCT.md Community code of conduct
SECURITY.md Security policy and vulnerability reporting
LICENSE Unlicense License terms

Configuration Files

File Purpose
cliff.toml git-cliff configuration for changelog generation
PSScriptAnalyzerSettings.psd1 ScriptAnalyzer rules and settings
package.json npm scripts and Node.js dependencies
.github/workflows/ GitHub Actions CI/CD workflows

Example Files

Location Description
docs/examples/ansi-conversion/ ANSI art conversion examples and samples
assets/ansi-files/ Source ANSI art files for conversion
docs/oversized-colorscripts/ Large colorscripts that don't fit in main Scripts folder

Special Setup Guides

Document Description
MEGALINTER-SETUP.md MegaLinter configuration and usage guide

Need Help

Using PowerShell Help System

PowerShell uses the Get-Help cmdlet instead of traditional --help flags:

# Get basic help
Get-Help Show-ColorScript

# Get detailed help with examples
Get-Help Show-ColorScript -Full

# Get only examples
Get-Help Show-ColorScript -Examples

# Get help for a specific parameter
Get-Help Show-ColorScript -Parameter Name

# Module help
Get-Help about_ColorScripts-Enhanced

# List all help topics
Get-Help *ColorScript*

Note: Traditional CLI flags like Show-ColorScript --help, -h, or -? will not work. Use Get-Help instead.

Other Resources

Version Information

  • Module Version: 2025.11.05.0244
  • Colorscripts: 498+
  • Functions: 10
  • PowerShell: 5.1+ and 7.0+
  • Platforms: Windows, macOS, Linux

Last updated: November 5, 2025