Skip to content

Commit 8ff260a

Browse files
committed
📝 [docs] Comprehensive documentation overhaul, regenerate help, bump module manifest & refresh build metadata
- 📝 [docs] Expand and modernize documentation across docs/ and module help (CONTRIBUTING.md, Development.md, TESTING.md, QUICK_REFERENCE.md, NPM_SCRIPTS.md, Publishing.md, ROADMAP.md, MODULE_SUMMARY.md, etc.): add "Advanced Usage" sections, best practices, troubleshooting, CI/CD & publishing guidance, performance benchmarking, terminal compatibility, and dozens of runnable examples. - ✨ [feat] Add summary & status artifacts to capture the work: DOCUMENTATION_ENHANCEMENT_COMPLETE.md, DOCUMENTATION_EXPANSION_SUMMARY.md, DOCUMENTATION_INDEX.md, DOCUMENTATION_STATUS_REPORT.md, HELP_ENHANCEMENTS_SUMMARY.md. - 🚜 [refactor] Propagate cmdlet naming / usage updates across docs and generated help: update references and examples to New-ColorScriptCache / Update-ColorScriptCache and refresh many en-US cmdlet help files (Add-ColorScriptProfile, Clear-ColorScriptCache, Export-ColorScriptMetadata, Get-ColorScriptConfiguration, Get-ColorScriptList, New-ColorScript, New-ColorScriptCache, Reset-ColorScriptConfiguration, Show-ColorScript). - 🧹 [chore] Bump module manifest ModuleVersion to 2025.10.30.1631 and update ReleaseNotes block and HelpInfo UICultureVersion to reflect the new build. - 👷 [ci] Regenerate help XML and refresh distribution release notes (dist/LatestReleaseNotes.md, dist/PowerShellGalleryReleaseNotes.md) so published help and changelogs match the expanded documentation and command updates. - 🛠️ [fix] Update build tooling and manifest generation (scripts/build.ps1): improve module description, include mascot & command overview, export Update-ColorScriptCache alias, normalize JSON/cache handling and apply minor link/content corrections. - 🧪 [test] Improve testing documentation and npm script docs: document Pester workflows, coverage commands, verify sequences and CI matrix; add example test patterns and verification steps for local CI simulation. - 🎨 [style] Polish wording, add quick-start snippets and cross-links, include "Last Updated" stamps and UX-oriented improvements across help pages for clearer developer & user guidance. Signed-off-by: Nick2bad4u <20943337+Nick2bad4u@users.noreply.github.com>
1 parent e315754 commit 8ff260a

36 files changed

Lines changed: 10215 additions & 257 deletions

CONTRIBUTING.md

Lines changed: 427 additions & 12 deletions
Large diffs are not rendered by default.

ColorScripts-Enhanced/ColorScripts-Enhanced.psd1

Lines changed: 51 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
RootModule = 'ColorScripts-Enhanced.psm1'
1212

1313
# Version number of this module.
14-
ModuleVersion = '2025.10.30.0107'
14+
ModuleVersion = '2025.10.30.1631'
1515

1616
# Supported PSEditions
1717
CompatiblePSEditions = @('Desktop', 'Core')
@@ -30,21 +30,55 @@
3030

3131
# Description of the functionality provided by this module
3232
Description = @'
33-
Enhanced PowerShell ColorScripts with high-performance caching system. Display beautiful ANSI art in your terminal with 6-19x faster load times.
34-
35-
Features:
36-
• 498 beautiful colorscripts - Extensive collection of ANSI art
37-
• Intelligent Caching - 6-19x performance improvement (5-20ms load times)
38-
• OS-Wide Cache - Consistent caching across all terminal sessions
39-
• Simple API - Easy-to-use cmdlets with tab completion
40-
• Configurable Defaults - Persist cache locations and startup behaviour
41-
• Auto-Update - Cache automatically invalidates when scripts change
42-
• Centralized Storage - Cache stored in AppData/ColorScripts-Enhanced/cache
43-
• Cross-platform - Works on Windows, Linux, and macOS
44-
• PowerShell 5.1+ and PowerShell Core 7+ compatible
45-
46-
Quick Start: Show-ColorScript (or alias: scs)
47-
Full documentation: https://github.com/Nick2bad4u/ps-color-scripts-enhanced
33+
🎨 ColorScripts-Enhanced: Professional ANSI Art Terminal Experience
34+
35+
![ColorScripts Mascot](https://raw.githubusercontent.com/Nick2bad4u/ps-color-scripts-enhanced/main/assets/ColorScripts-Mascot-Dark.jpeg)
36+
37+
A powerful PowerShell module that brings beautiful ANSI art colorscripts to your terminal with enterprise-grade performance. Choose from 498 stunning visual scripts and enjoy lightning-fast loading with intelligent caching.
38+
39+
⚡ PERFORMANCE BOOST
40+
• 6-19x faster performance with smart caching
41+
• 5-20ms average load time (cached)
42+
• OS-wide cache across all terminal sessions
43+
• Automatic cache invalidation on script updates
44+
45+
✨ FEATURES
46+
• 498 beautiful colorscripts included
47+
• Professional-grade ANSI art collection
48+
• Cross-platform support (Windows, macOS, Linux)
49+
• PowerShell 5.1+ and PowerShell 7+ compatible
50+
• Tab completion and intelligent parameter handling
51+
• Centralized cache in AppData/ColorScripts-Enhanced
52+
• Configuration persistence for user preferences
53+
• Rich metadata and script discovery
54+
55+
🚀 QUICK START
56+
Display random art: Show-ColorScript (or use alias: scs)
57+
List available scripts: Get-ColorScriptList
58+
Pre-build cache: New-ColorScriptCache
59+
60+
📖 DOCUMENTATION
61+
Full guide: https://github.com/Nick2bad4u/ps-color-scripts-enhanced
62+
Issues & Discussions: https://github.com/Nick2bad4u/ps-color-scripts-enhanced/issues
63+
64+
COMMANDS INCLUDED
65+
• Show-ColorScript - Display colorscripts with caching
66+
• Get-ColorScriptList - Browse available scripts
67+
• New-ColorScriptCache - Pre-generate cache for speed
68+
• Clear-ColorScriptCache - Manage cache storage
69+
• Add-ColorScriptProfile - Integrate into PowerShell profile
70+
• Get-ColorScriptConfiguration - View settings
71+
• Set-ColorScriptConfiguration - Persist preferences
72+
• Export-ColorScriptMetadata - Export script metadata
73+
• New-ColorScript - Create new colorscripts
74+
75+
PERFECT FOR
76+
✓ Making your terminal visually stunning
77+
✓ Terminal startup customization
78+
✓ System administration dashboards
79+
✓ Development environments
80+
✓ DevOps automation
81+
✓ Learning ANSI art and terminal graphics
4882
'@
4983

5084
# Minimum version of the PowerShell engine required by this module
@@ -172,7 +206,7 @@ Full documentation: https://github.com/Nick2bad4u/ps-color-scripts-enhanced
172206

173207
# ReleaseNotes of this module
174208
ReleaseNotes = @'
175-
Version 2025.10.30.0107:
209+
Version 2025.10.30.1631:
176210
- Enhanced caching system with OS-wide cache in AppData
177211
- 6-19x performance improvement
178212
- Cache stored in centralized location

0 commit comments

Comments
 (0)