Pode.Web icon indicating copy to clipboard operation
Pode.Web copied to clipboard

Update Docs and Readme

Open thekamilpro opened this issue 3 years ago • 2 comments

Description of the Change

Add description for -MaxLength parameter. Add instructions on how to build pode.web on Windows.

Related Issue

n/a

Additional Context

It took me some time to build the module for the first time - I needed read pipeline definition to find out which modules are being used, then how to get yarn etc. I hope this little guide would hopefully encourage more people to contribute.

thekamilpro avatar Aug 29 '22 13:08 thekamilpro

Added one more change for Table examples - the Start-Service button was configured to use -Force parameter, which doesn't exist for this cmdlet (I KNOW!), failing for example to execute action for the button.

thekamilpro avatar Aug 30 '22 19:08 thekamilpro

Aah, for the Build Dependencies it might be worth updating the .build.ps1 file to install the dependencies. They're there for making the docs, but I didn't setup Build the same ; it using choco to do the install there - even installs choco if missing - and has some support for *nix systems.

If you'd like the tackle it, the task DocsDeps is an example of how it works, and Pode has the same setup :)

Badgerati avatar Aug 30 '22 21:08 Badgerati