-
-
Notifications
You must be signed in to change notification settings - Fork 105
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 #251
Comments
I've created a short checklist of things to check:
|
* Revised LEARNING.MD (part of #251) * Moved some contents to RESOURCES.md * Fix F# header not rendering # * More videos * Removed expert f# book
Note to self: I should add PluralSight to RESOURCES.md and add a beginner F# PluralSight course to LEARNING.md. |
How do you feel about including a link to this MSDN F# elevator pitch? It arguably doesn't meet the "short" requirement for the introduction which is why I'm suggesting linking to it for people that aren't convinced with the one sentence description that we already have there. |
I really like the pitch, but I do think the introduction should just be text. Perhaps we could extract some of the more relevant parts of the pitch and condense them in one or two sentences? The parts I like best are:
And
|
@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 Some languages usually somewhat longer text in their ABOUT.md file, e.g. rust, ruby and go. I think we can also do that then. Perhaps we can borrow some content from http://fsharpforfunandprofit.com/why-use-fsharp/? |
@ErikSchierboom that sounds good to me! |
That sounds like a plan.
As long as we're not plagiarizing, that sounds excellent :-) |
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
Fixed by #348. |
Each language track has documentation in the
docs/
directory, which gets included on the siteon 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.
The text was updated successfully, but these errors were encountered: