Badgerati / Pode

Pode is a Cross-Platform PowerShell web framework for creating REST APIs, Web Sites, and TCP/SMTP servers
https://badgerati.github.io/Pode
MIT License
845 stars 92 forks source link

Cleans up the Examples in the repository, and adds them to the Documentation #1333

Closed mdaneri closed 1 month ago

mdaneri commented 4 months ago

Changes:

Header Example

<#
.SYNOPSIS
    A sample PowerShell script to set up a Pode server and integrate with Redis for caching.
.DESCRIPTION
    This script sets up a Pode server listening on port 8081 with Redis integration for caching.
    It checks for the existence of the `redis-cli` command and sets up a Pode server with routes
    that demonstrate caching with Redis.
.NOTES
    Author: Pode Team
    License: MIT License
#>
mdaneri commented 3 months ago

I still need to do with this. I plan to make a change in Pode.build.ps1 to automatically create an MD document with any example with a brief description + a test to check if any example has the correct header for the build to generate the page. The Webhook sample is an example of what I mean

Badgerati commented 3 months ago

Aah I see, in a similar way to how the Function MDs are made with PlatyPS?

Couple of ideas, apologies if these are already planned! Would it be worth adding the following headers?

mdaneri commented 3 months ago

.LINK is available on the summary page .EXAMPLE do you think is really needed?