Skip to content

Commit ebe748e

Browse files
Nick2bad4uNick2bad4u
committed
đź“ť [docs] Tidy documentation tables, refresh publishing links, and normalize link-check config
 - 📝 [docs] Reformat docs/DOCUMENTATION_INDEX.md tables for consistent column alignment and improved readability - 📝 [docs] Update docs/Publishing.md external references to canonical Microsoft and GitHub URLs and add minor spacing adjustments for clarity - 🧹 [chore] Normalize .markdown-link-check.json formatting (remove stray blank line, compact arrays/objects) for consistent JSON style Signed-off-by: Nick2bad4u <20943337+Nick2bad4u@users.noreply.github.com>
1 parent e30a3fa commit ebe748e

4 files changed

Lines changed: 76 additions & 83 deletions

File tree

‎.markdown-link-check.json‎

Lines changed: 15 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
{
2-
32
"ignorePatterns": [
43
{
54
"pattern": "^https://i\\.imgur\\.com/"
@@ -59,27 +58,19 @@
5958
"timeout": "20s",
6059
"retryOn429": true,
6160
"retryCount": 3,
62-
"aliveStatusCodes": [
63-
200,
64-
206,
65-
301,
66-
302,
67-
303,
68-
307,
69-
308
70-
],
71-
"fallbackRetryDelay": "30s",
72-
"httpHeaders": [
73-
{
74-
"headers": {
75-
"Accept-Encoding": "zstd, br, gzip, deflate",
76-
"User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36"
77-
},
78-
"urls": [
79-
"https://github.com",
80-
"https://api.github.com",
81-
"https://raw.githubusercontent.com"
82-
]
83-
}
84-
]
61+
"aliveStatusCodes": [200, 206, 301, 302, 303, 307, 308],
62+
"fallbackRetryDelay": "30s",
63+
"httpHeaders": [
64+
{
65+
"headers": {
66+
"Accept-Encoding": "zstd, br, gzip, deflate",
67+
"User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36"
68+
},
69+
"urls": [
70+
"https://github.com",
71+
"https://api.github.com",
72+
"https://raw.githubusercontent.com"
73+
]
74+
}
75+
]
8576
}

‎ColorScripts-Enhanced/ColorScripts-Enhanced.psd1‎

Lines changed: 2 additions & 2 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.13.1600'
14+
ModuleVersion = '2025.10.13.1615'
1515

1616
# Supported PSEditions
1717
CompatiblePSEditions = @('Desktop', 'Core')
@@ -171,7 +171,7 @@ Full documentation: https://github.com/Nick2bad4u/ps-color-scripts-enhanced
171171

172172
# ReleaseNotes of this module
173173
ReleaseNotes = @'
174-
Version 2025.10.13.1600:
174+
Version 2025.10.13.1615:
175175
- Enhanced caching system with OS-wide cache in AppData
176176
- 6-19x performance improvement
177177
- Cache stored in centralized location

‎docs/DOCUMENTATION_INDEX.md‎

Lines changed: 54 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -13,95 +13,95 @@ Complete guide to all documentation files in this repository.
1313

1414
### Installation & Setup
1515

16-
| Document | Description |
17-
|----------|-------------|
18-
| [README.md](../README.md) | Main project documentation with installation, usage, and examples |
19-
| [ColorScripts-Enhanced/README.md](../ColorScripts-Enhanced/README.md) | Module-specific documentation (identical to main README) |
20-
| [QUICK_REFERENCE.md](QUICK_REFERENCE.md) | Command reference and common usage patterns |
16+
| Document | Description |
17+
| --------------------------------------------------------------------- | ----------------------------------------------------------------- |
18+
| [README.md](../README.md) | Main project documentation with installation, usage, and examples |
19+
| [ColorScripts-Enhanced/README.md](../ColorScripts-Enhanced/README.md) | Module-specific documentation (identical to main README) |
20+
| [QUICK_REFERENCE.md](QUICK_REFERENCE.md) | Command reference and common usage patterns |
2121

2222
### Command Help
2323

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

26-
| Command | Help File |
27-
|---------|-----------|
28-
| `Show-ColorScript` | [Show-ColorScript.md](../ColorScripts-Enhanced/en-US/Show-ColorScript.md) |
29-
| `Get-ColorScriptList` | [Get-ColorScriptList.md](../ColorScripts-Enhanced/en-US/Get-ColorScriptList.md) |
30-
| `Build-ColorScriptCache` | [Build-ColorScriptCache.md](../ColorScripts-Enhanced/en-US/Build-ColorScriptCache.md) |
31-
| `Clear-ColorScriptCache` | [Clear-ColorScriptCache.md](../ColorScripts-Enhanced/en-US/Clear-ColorScriptCache.md) |
32-
| `Add-ColorScriptProfile` | [Add-ColorScriptProfile.md](../ColorScripts-Enhanced/en-US/Add-ColorScriptProfile.md) |
33-
| `Get-ColorScriptConfiguration` | [Get-ColorScriptConfiguration.md](../ColorScripts-Enhanced/en-US/Get-ColorScriptConfiguration.md) |
34-
| `Set-ColorScriptConfiguration` | [Set-ColorScriptConfiguration.md](../ColorScripts-Enhanced/en-US/Set-ColorScriptConfiguration.md) |
26+
| Command | Help File |
27+
| -------------------------------- | ----------------------------------------------------------------------------------------------------- |
28+
| `Show-ColorScript` | [Show-ColorScript.md](../ColorScripts-Enhanced/en-US/Show-ColorScript.md) |
29+
| `Get-ColorScriptList` | [Get-ColorScriptList.md](../ColorScripts-Enhanced/en-US/Get-ColorScriptList.md) |
30+
| `Build-ColorScriptCache` | [Build-ColorScriptCache.md](../ColorScripts-Enhanced/en-US/Build-ColorScriptCache.md) |
31+
| `Clear-ColorScriptCache` | [Clear-ColorScriptCache.md](../ColorScripts-Enhanced/en-US/Clear-ColorScriptCache.md) |
32+
| `Add-ColorScriptProfile` | [Add-ColorScriptProfile.md](../ColorScripts-Enhanced/en-US/Add-ColorScriptProfile.md) |
33+
| `Get-ColorScriptConfiguration` | [Get-ColorScriptConfiguration.md](../ColorScripts-Enhanced/en-US/Get-ColorScriptConfiguration.md) |
34+
| `Set-ColorScriptConfiguration` | [Set-ColorScriptConfiguration.md](../ColorScripts-Enhanced/en-US/Set-ColorScriptConfiguration.md) |
3535
| `Reset-ColorScriptConfiguration` | [Reset-ColorScriptConfiguration.md](../ColorScripts-Enhanced/en-US/Reset-ColorScriptConfiguration.md) |
36-
| `Export-ColorScriptMetadata` | [Export-ColorScriptMetadata.md](../ColorScripts-Enhanced/en-US/Export-ColorScriptMetadata.md) |
37-
| `New-ColorScript` | [New-ColorScript.md](../ColorScripts-Enhanced/en-US/New-ColorScript.md) |
36+
| `Export-ColorScriptMetadata` | [Export-ColorScriptMetadata.md](../ColorScripts-Enhanced/en-US/Export-ColorScriptMetadata.md) |
37+
| `New-ColorScript` | [New-ColorScript.md](../ColorScripts-Enhanced/en-US/New-ColorScript.md) |
3838

3939
**Module Help**: [about_ColorScripts-Enhanced.help.txt](../ColorScripts-Enhanced/en-US/about_ColorScripts-Enhanced.help.txt)
4040

4141
### Technical Guides
4242

43-
| Document | Description |
44-
|----------|-------------|
45-
| [ANSI-COLOR-GUIDE.md](ANSI-COLOR-GUIDE.md) | ANSI escape codes reference and color palette guide |
43+
| Document | Description |
44+
| ---------------------------------------------------- | ---------------------------------------------------- |
45+
| [ANSI-COLOR-GUIDE.md](ANSI-COLOR-GUIDE.md) | ANSI escape codes reference and color palette guide |
4646
| [ANSI-CONVERSION-GUIDE.md](ANSI-CONVERSION-GUIDE.md) | Converting ANSI art files to PowerShell colorscripts |
47-
| [POWERSHELL-VERSIONS.md](POWERSHELL-VERSIONS.md) | PowerShell version compatibility matrix |
47+
| [POWERSHELL-VERSIONS.md](POWERSHELL-VERSIONS.md) | PowerShell version compatibility matrix |
4848

4949
## Developer Documentation
5050

5151
### Development Workflow
5252

53-
| Document | Description |
54-
|----------|-------------|
55-
| [Development.md](Development.md) | Local development setup, tooling, and workflows |
56-
| [MODULE_SUMMARY.md](MODULE_SUMMARY.md) | Complete module implementation overview |
57-
| [CONTRIBUTING.md](../CONTRIBUTING.md) | How to contribute code, scripts, and documentation |
53+
| Document | Description |
54+
| -------------------------------------- | -------------------------------------------------- |
55+
| [Development.md](Development.md) | Local development setup, tooling, and workflows |
56+
| [MODULE_SUMMARY.md](MODULE_SUMMARY.md) | Complete module implementation overview |
57+
| [CONTRIBUTING.md](../CONTRIBUTING.md) | How to contribute code, scripts, and documentation |
5858

5959
### Release & Publishing
6060

61-
| Document | Description |
62-
|----------|-------------|
63-
| [Publishing.md](Publishing.md) | Publishing to PowerShell Gallery, NuGet.org, and GitHub Packages |
64-
| [ReleaseChecklist.md](ReleaseChecklist.md) | Step-by-step release checklist with git-cliff integration |
65-
| [CHANGELOG.md](../CHANGELOG.md) | Complete project changelog |
61+
| Document | Description |
62+
| ------------------------------------------ | ---------------------------------------------------------------- |
63+
| [Publishing.md](Publishing.md) | Publishing to PowerShell Gallery, NuGet.org, and GitHub Packages |
64+
| [ReleaseChecklist.md](ReleaseChecklist.md) | Step-by-step release checklist with git-cliff integration |
65+
| [CHANGELOG.md](../CHANGELOG.md) | Complete project changelog |
6666

6767
### Project Management
6868

69-
| Document | Description |
70-
|----------|-------------|
71-
| [ROADMAP.md](ROADMAP.md) | Project roadmap and planned features |
72-
| [SUPPORT.md](SUPPORT.md) | Support channels and response time expectations |
73-
| [CONTRIBUTORS.md](CONTRIBUTORS.md) | List of project contributors |
74-
| [todo.md](../todo.md) | Development tasks and action items |
69+
| Document | Description |
70+
| ---------------------------------- | ----------------------------------------------- |
71+
| [ROADMAP.md](ROADMAP.md) | Project roadmap and planned features |
72+
| [SUPPORT.md](SUPPORT.md) | Support channels and response time expectations |
73+
| [CONTRIBUTORS.md](CONTRIBUTORS.md) | List of project contributors |
74+
| [todo.md](../todo.md) | Development tasks and action items |
7575

7676
## Repository Policies
7777

78-
| Document | Description |
79-
|----------|-------------|
80-
| [CODE_OF_CONDUCT.md](../CODE_OF_CONDUCT.md) | Community code of conduct |
81-
| [SECURITY.md](../SECURITY.md) | Security policy and vulnerability reporting |
82-
| [LICENSE](../LICENSE) | MIT License terms |
78+
| Document | Description |
79+
| ------------------------------------------- | ------------------------------------------- |
80+
| [CODE_OF_CONDUCT.md](../CODE_OF_CONDUCT.md) | Community code of conduct |
81+
| [SECURITY.md](../SECURITY.md) | Security policy and vulnerability reporting |
82+
| [LICENSE](../LICENSE) | MIT License terms |
8383

8484
## Configuration Files
8585

86-
| File | Purpose |
87-
|------|---------|
88-
| [cliff.toml](../cliff.toml) | git-cliff configuration for changelog generation |
89-
| [PSScriptAnalyzerSettings.psd1](../PSScriptAnalyzerSettings.psd1) | ScriptAnalyzer rules and settings |
90-
| [package.json](../package.json) | npm scripts and Node.js dependencies |
91-
| [.github/workflows/](../.github/workflows/) | GitHub Actions CI/CD workflows |
86+
| File | Purpose |
87+
| ----------------------------------------------------------------- | ------------------------------------------------ |
88+
| [cliff.toml](../cliff.toml) | git-cliff configuration for changelog generation |
89+
| [PSScriptAnalyzerSettings.psd1](../PSScriptAnalyzerSettings.psd1) | ScriptAnalyzer rules and settings |
90+
| [package.json](../package.json) | npm scripts and Node.js dependencies |
91+
| [.github/workflows/](../.github/workflows/) | GitHub Actions CI/CD workflows |
9292

9393
## Example Files
9494

95-
| Location | Description |
96-
|----------|-------------|
97-
| [examples/ansi-conversion/](../examples/ansi-conversion/) | ANSI art conversion examples and samples |
98-
| [ansi-files/](../ansi-files/) | Source ANSI art files for conversion |
99-
| [oversized-colorscripts/](../oversized-colorscripts/) | Large colorscripts that don't fit in main Scripts folder |
95+
| Location | Description |
96+
| --------------------------------------------------------- | -------------------------------------------------------- |
97+
| [examples/ansi-conversion/](../examples/ansi-conversion/) | ANSI art conversion examples and samples |
98+
| [ansi-files/](../ansi-files/) | Source ANSI art files for conversion |
99+
| [oversized-colorscripts/](../oversized-colorscripts/) | Large colorscripts that don't fit in main Scripts folder |
100100

101101
## Special Setup Guides
102102

103-
| Document | Description |
104-
|----------|-------------|
103+
| Document | Description |
104+
| ------------------------------------------ | ---------------------------------------- |
105105
| [MEGALINTER-SETUP.md](MEGALINTER-SETUP.md) | MegaLinter configuration and usage guide |
106106

107107
## Need Help?

‎docs/Publishing.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,14 @@ The `.github/workflows/publish.yml` workflow automates the entire publish proces
3030
6. **Publish to Galleries** - Pushes to PowerShell Gallery, NuGet.org, and GitHub Packages
3131

3232
The workflow can be triggered:
33+
3334
- Manually via `workflow_dispatch` with customizable options
3435
- Automatically when tests pass on the main branch
3536

3637
### Manual Trigger Options
3738

3839
When manually triggering the publish workflow, you can control:
40+
3941
- `publishToNuGet` - Publish to NuGet.org (default: true)
4042
- `publishToGitHub` - Publish to GitHub Packages (default: true)
4143
- `versionOverride` - Override the manifest version
@@ -154,6 +156,6 @@ Publish-Module -Path ./ColorScripts-Enhanced -Repository MyCompanyFeed
154156

155157
## Additional Resources
156158

157-
- PowerShell Gallery Publishing Docs: <https://learn.microsoft.com/powershell/gallery/how-to/publishing-packages>
158-
- PSResourceGet Guide: <https://learn.microsoft.com/powershell/gallery/psresourceget/overview>
159-
- GitHub Packages with PowerShell: <https://learn.microsoft.com/powershell/gallery/how-to/working-with-packages#github-packages>
159+
- PowerShell Gallery Publishing Docs: <https://learn.microsoft.com/en-us/powershell/gallery/how-to/publishing-packages/publishing-a-package?view=powershellget-3.x>
160+
- PSResourceGet Guide: <https://learn.microsoft.com/en-us/powershell/gallery/overview?view=powershellget-3.x>
161+
- GitHub Packages with PowerShell: <https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry>

0 commit comments

Comments
 (0)