MethodsAndPractices / vsteam

PowerShell module for accessing Azure DevOps Services and Azure DevOps Server (formerly VSTS or TFS)
https://methodsandpractices.github.io/vsteam-docs/
MIT License
447 stars 155 forks source link

Make it easier to find the documentation please! #510

Open curtmgray opened 1 year ago

curtmgray commented 1 year ago

Proposal

It's hard to find the documentation from the main Github page for this. I only just now accidently found https://methodsandpractices.github.io/ by clicking around and stumbled into it.

The page for the wiki goes to an error 404 page when I try to look at the documentation there.

Solved Problem

No response

Additional info / code snippets?

No response

MichelZ commented 1 year ago

also, @SebastianSchuetze the Wiki has a 404 docs link

SebastianSchuetze commented 1 year ago

@MichelZ I fixed the link!

@curtmgray thank you so much for bringing this to my attention. I truly appreciate your interest and concern for the accessibility of our documentation.

I'd like to point out that we've tried to make our documentation as easily accessible as possible. For instance, we've placed a link at the very root of the repository and also at the beginning of the repo README. We believe that this is a standard practice and is generally effective in guiding users to necessary information.

If you're seeking detailed guidance on any of our cmdlets, there's a convenient option for that as well. For example, you can use the Get-Help Get-VSTeam -Online command which will directly open up the relevant help page in your browser. If you prefer to avoid the online option, simply drop the -Online parameter to get the same documentation.

That being said, we are always open to suggestions for improvements. If you have specific ideas on how we can make our documentation even easier to find and navigate, please don't hesitate to share. Your feedback is invaluable to us as we strive to provide the best possible user experience.

Once again, thank you for your time and input. I look forward to hearing any further suggestions you may have.