Skip to content

Verify contents and format of track documentation #147

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
kytrinyx opened this issue Dec 16, 2016 · 4 comments · Fixed by #199
Closed

Verify contents and format of track documentation #147

kytrinyx opened this issue Dec 16, 2016 · 4 comments · Fixed by #199
Assignees

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.

@ErikSchierboom
Copy link
Member

ErikSchierboom commented Dec 19, 2016

I've created a short checklist of things to check:

  • INSTALLATION.md - how to install the language and any dependencies
  • TESTS.md - how to run the tests
  • ABOUT.md - short, enticing introduction to the language
  • LEARNING.md - where to get an introduction to the language if you're learning it for the first time
  • RESOURCES.md - references, tools, etc.
  • Put images in docs/img

@ErikSchierboom
Copy link
Member

@kytrinyx Updating the TESTS.md and INSTALLATION.md is something I'd like to keep open for a while, as we expect to do a rather massive overhoal once F# runs on the updated .NET Core 2.0. That will be sometime in the first quarter of 2017 probably.

@robkeim
Copy link
Contributor

robkeim commented Dec 25, 2016

@ErikSchierboom I think you mean C# :)

@ErikSchierboom
Copy link
Member

Ehm, yes. That's what you get when you copy-paste text...

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

Successfully merging a pull request may close this issue.

3 participants