-
Notifications
You must be signed in to change notification settings - Fork 167
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
(doc) Add/update docs for Chocolatey.PowerShell module #993
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't have an issue with the slightly different format between this and the existing function docs. All I can see is the capitalisation of the headings which is consistent with what appears in the PowerShell comment based help.
Having said that, if this is the new format we are doing things then we should ensure that as we migrate more functions to cmdlets, we are using this new format. Consistency is important.
I will leave @gep13 to discuss the change of format, file locations etc.
Moved rewritten cmdlets docs to new cmdlets folder, retaining xrefs. Updated cmdlet docs to use platyPS generated doc format.
Add missing redirects Correct capitalization on xref
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
@vexx32 thanks for getting this added, and to @st3phhays and @pauby for the reviews. I have enabled auto-merge so the PR will be merged once the CI build completes. |
Merge pull request #993 from vexx32/update-cmdlet-docs (doc) Add/update docs for Chocolatey.PowerShell module
Description Of Changes
Adds / updates docs for changes in chocolatey/choco#3440
Motivation and Context
Twofold; one, new command, new docs. Two, the GenerateDocs.ps1 won't work for the new cmdlets and it would be hairy to tie them together. Instead, we're using PlatyPS to generate/maintain these docs, so they need to be in a separate folder (unfortunately).
I have retained the old links and xrefs from the original PowerShell Functions Reference page, so that all cmdlets can still be accessed from that index.
Eventually when everything has moved over to this new section as we progress with cmdlet rewrites, we can collapse the two sections back into one again.
Testing
Change Types Made
Change Checklist
Related Issue
chocolatey/choco#3440