search

pester / docs

Source files for the Pester website.
https://pester.dev
MIT License
41 stars 76 forks source link

Add v6 preview docs #316

Open fflaten opened 3 weeks ago

fflaten commented 3 weeks ago

Versions v5 docs (./versioned_docs/v5/*) and promotes current (./docs/*) to v6 preview.

URLs:

Includes PesterConfiguration reference in Usage/Configuration page.

Checklist:

Fix #312 Fix pester/pester#2459 Fix #280 Related pester/pester#2464

nohwnd commented 3 weeks ago

Will it help if I release sooner rather than later?

fflaten commented 3 weeks ago

No hurry. I can build command ref from local build for now.

fflaten commented 2 weeks ago

@bravo-kernel: Thoughts on PR and versioning strategy? Just playing around atm. but considering merging something this week before PSConfEU 🙂

bravo-kernel commented 2 weeks ago

@fflaten I have been AFK and will need to find some time to look at this (soon).

bravo-kernel commented 2 weeks ago

@fflaten awesome job and the preview looks great. Are there any remaining issues you need feedback on?

fflaten commented 2 weeks ago

@fflaten awesome job and the preview looks great. Are there any remaining issues you need feedback on?

Thanks 🙌 My initial review questions was:

Should I split this into multiple PRs maybe?

bravo-kernel commented 2 weeks ago 
* Versioning / URL scheme: Keep pester.dev/docs for current stable? Always versioned?

  * There's a related question [here](https://github.com/pester/docs/pull/267#issuecomment-2169814740)
  * I believe the current iteration with /docs as stable like before with /docs/v<stable> -> /docs redirect might be best. Will allow both types (so module help can refer to versioned URL) while keeping a stable canonical link for search engines so we keep our rank in search results (improved SEO)

I am not sure what you are suggesting here but also do not really have a preference. We once chose the current logic with stable being /docs and I think it was because it was the Docusaurus default (at that time). Honestly, you have spent a lot of time on this topic so you would probably know best how to proceed here.

  * Was wondering if Docusaurus-module could support versioned docs. E.g. update the versioned sidebar json OR at highlight any added/removed pages between updates. Might be an edge case though. Not sure how many use versioned docs for majors only vs minor versions which a new/removed command would typically require.

I think we could do the first option. Will need to investigate but perhaps adding a new -Version parameter is all that is needed to generate/update the correct versioned sidebar (because we already have https://docusaurus-powershell.vercel.app/docs/commands/New-DocusaurusHelp#-sidebar).

* PesterConfiguration docs placement and style

In progress.

Should I split this into multiple PRs maybe?

Not necessary for me at all, we can always quick fix after merging anyway.

bravo-kernel commented 2 weeks ago

New configuration looks great @fflaten

fflaten commented 2 weeks ago

@nohwnd Time for a quick review and maybe merge?

Highlights and questions:

Tips to save time: