Skip to content
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

Make it easier to find the documentation please! #510

Open
curtmgray opened this issue Jan 10, 2023 · 2 comments
Open

Make it easier to find the documentation please! #510

curtmgray opened this issue Jan 10, 2023 · 2 comments
Labels
enhancement Improvements that do not include new features feature request for new feature requests that do not just improve things

Comments

@curtmgray
Copy link

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

@curtmgray curtmgray added enhancement Improvements that do not include new features feature request for new feature requests that do not just improve things labels Jan 10, 2023
@MichelZ
Copy link
Contributor

MichelZ commented May 18, 2023

also, @SebastianSchuetze the Wiki has a 404 docs link

@SebastianSchuetze
Copy link
Collaborator

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvements that do not include new features feature request for new feature requests that do not just improve things
Projects
None yet
Development

No branches or pull requests

3 participants