[WIP] GroupByVerb parameter and behaviours.

alt3 / Docusaurus.Powershell

Docusaurus websites for PowerShell modules

https://docusaurus-powershell.vercel.app/

MIT License

28 stars 11 forks source link

[WIP] GroupByVerb parameter and behaviours. #166

Open homotechsual opened 1 year ago

homotechsual commented 1 year ago

This adds a -GroupByVerb parameter and associated functionality including:

Splits the markdown files into subfolders by approved PowerShell verb.
Alters folder cleaning to recurse into the verb folders (but doesn't remove the folders yet)
Alters sidebar generation to reflect the subfolder structure.
Changes some existing simple array generation to [System.Collections.Generic.List[]] for speed and ease of collection population.

Discussion points:

Should it remove empty verb folders if found when cleaning? (I would like this to happen - but would like wider input.)
Any fundamental changes to this approach you'd like to see?
Test plan?

vercel[bot] commented 1 year ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docusaurus-powershell	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 25, 2023 10:43pm

bravo-kernel commented 1 year ago

Thanks for putting this up here, I will take a look into it when I find some time. Refs #129.

homotechsual commented 1 year ago

It's in use on https://dev.homotechsualdocs.pages.dev/ for the HaloAPI and NinjaOne modules.

bravo-kernel commented 1 year ago

Apologies for the delay, I needed to fix the CI pipeline first. Could you please rebase against main and let me know so we can start the test suite? After that, we will take it from there.

homotechsual commented 1 year ago

Sure - I also have a couple more tweaks I've made from using this "in anger" that I'll fold in :-)

homotechsual commented 1 year ago

Might be a week or so though!

bravo-kernel commented 1 year ago

No worries, take your time 👍