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

Verify contents and format of track documentation #458

Closed
kytrinyx opened this issue Dec 16, 2016 · 2 comments
Closed

Verify contents and format of track documentation #458

kytrinyx opened this issue Dec 16, 2016 · 2 comments

Comments

@kytrinyx
Copy link
Member

Each language track has documentation in the docs/ directory, which gets included on the site
on each track-specific set of pages under /languages.

We've added some general guidelines about how we'd like the track to be documented in exercism/exercism#3315
which can be found at https://github.com/exercism/exercism.io/blob/master/docs/writing-track-documentation.md

Please take a moment to look through the documentation about documentation, and make sure that
the track is following these guidelines. Pay particularly close attention to how to use images
in the markdown files.

Lastly, if you find that the guidelines are confusing or missing important details, then a pull request
would be greatly appreciated.

@petertseng
Copy link
Member

petertseng commented Dec 19, 2016

This language track has these docs:

Finally, we have no images in any of the docs in the docs directory (we do have one image in our README.md - the Travis CI icon - but that is not displayed on the website).

Given the above information, I claim that this track meets the basic requirements set out in this issue.

Of course, anyone reading is free to help us improve our documentation. The above assertion that we meet the basic requirements doesn't necessarily mean that all the docs are perfect and never need changes again.

@rbasso
Copy link
Contributor

rbasso commented Dec 19, 2016

It does seem that Stack will manage installing GHC for the student. Am I correct in my understanding? If not, we need to change this. Can you confirm @rbasso?

Stack will use the system's GHC is it has the correct version, otherwise it will ask the user to install the required version running stack setup, as we explain in TESTS.md.

I decided to put the explanation about it in TESTS.md instead of INSTALLATION.md because the user may need to run it again if we update the exercises to use a new GHC, and at the time I considered this as different from a initial setup.

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

3 participants