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

Link to installation guide? #32

Closed
lisaychuang opened this issue Oct 1, 2017 · 3 comments
Closed

Link to installation guide? #32

lisaychuang opened this issue Oct 1, 2017 · 3 comments

Comments

@lisaychuang
Copy link
Collaborator

lisaychuang commented Oct 1, 2017

Hi Libby,

I'm going through CONTRIBUTING.md, and the first link in Filing an issue to get Smooch working on your own computer is a broken link with 404 error.

I see that there's a section further down the guide to Run Smooch on your computer -- should I just update the link to this section? Or to create a new file (e.g. install.md)

Thanks!
Lisa

@lisaychuang
Copy link
Collaborator Author

lisaychuang commented Oct 1, 2017

I've updated the link in pull request #33.

An example of a great installation guide included in README.md file is @mike-north's repo: https://github.com/mike-north/vscode-fundamentals/blob/master/README.md

@emhoracek
Copy link
Owner

@lisaychuang Thanks so much! I'm definitely still figuring out how to document stuff so I really appreciate resources like this! I've spent so much time in Haskell -- land of zero documentation -- I've forgotten what good docs look like!

@emhoracek
Copy link
Owner

Fixed by #33

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants