Skip to content

[Docs]: Link docs in GitHub README #5020

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

Closed
swetepete opened this issue Mar 23, 2022 · 4 comments · Fixed by #5041
Closed

[Docs]: Link docs in GitHub README #5020

swetepete opened this issue Mar 23, 2022 · 4 comments · Fixed by #5041
Assignees
Labels
docs Documentation related
Milestone

Comments

@swetepete
Copy link

What is your suggestion?

mention Mac as a valid installation platform

How will this improve the docs?

People use it on Mac but the docs only say Linux

Are you interested in submitting a PR for this?

@swetepete swetepete added the docs Documentation related label Mar 23, 2022
@jsjoeio
Copy link
Contributor

jsjoeio commented Mar 23, 2022

This is mentioned right here: https://coder.com/docs/code-server/latest/install#macos

@jsjoeio jsjoeio closed this as completed Mar 23, 2022
@jsjoeio
Copy link
Contributor

jsjoeio commented Mar 23, 2022

But if you have suggestions to improve it, let us know and I will reopen!

@swetepete
Copy link
Author

I often go straight to the GitHub for a tool and I still haven’t seen anything mentioned about it on the GitHub page. It says “requirements, Linux” in the README. I also didn’t find the docs clearly linked in the README. The homepage but not a direct link to the docs. I think this would make the GitHub a lot clearer. Thanks

@jsjoeio
Copy link
Contributor

jsjoeio commented Mar 28, 2022

I also didn’t find the docs clearly linked in the README. The homepage but not a direct link to the docs. I think this would make the GitHub a lot clearer. Thanks

That is very odd...Maybe we used to and it got removed? Great feedback though. Gonna reopen this and change the title. Thank you!

@jsjoeio jsjoeio reopened this Mar 28, 2022
@jsjoeio jsjoeio changed the title [Docs]: Add Mac [Docs]: Link docs in GitHub README Mar 28, 2022
@jsjoeio jsjoeio added this to the April 2022 milestone Mar 28, 2022
@jsjoeio jsjoeio self-assigned this Mar 29, 2022
@jsjoeio jsjoeio modified the milestones: April 2022, 4.3.0 Apr 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants