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 #251

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

Verify contents and format of track documentation #251

kytrinyx opened this issue Dec 16, 2016 · 11 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.

@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

This was referenced Dec 24, 2016
robkeim pushed a commit that referenced this issue Dec 24, 2016
* Revised LEARNING.MD (part of #251)

* Moved some contents to RESOURCES.md

* Fix F# header not rendering #

* More videos

* Removed expert f# book
@ErikSchierboom
Copy link
Member

@robkeim What do you think about our ABOUT.md file? It should be a "short, enticing introduction to the language". I think it's good, but maybe you have suggestions?

@ErikSchierboom
Copy link
Member

Note to self: I should add PluralSight to RESOURCES.md and add a beginner F# PluralSight course to LEARNING.md.

@robkeim
Copy link
Contributor

robkeim commented Dec 24, 2016

How do you feel about including a link to this MSDN F# elevator pitch?
https://blogs.msdn.microsoft.com/chrsmith/2008/11/01/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.

@ErikSchierboom
Copy link
Member

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:

Abstracting algorithms, numeric computation, data analysis and exploration – all of these things are just easier in F#. Because that’s what the language is built to do.

And

And, because of the interoperability of the CLR, you can use it directly with your C# code and your boss/team is none the wiser.

@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.

@ErikSchierboom
Copy link
Member

@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/?

@robkeim
Copy link
Contributor

robkeim commented Dec 29, 2016

@ErikSchierboom that sounds good to me!

@kytrinyx
Copy link
Member Author

kytrinyx commented Jan 2, 2017

Updating the TESTS.md and INSTALLATION.md is something I'd like to keep open for a while

That sounds like a plan.

Perhaps we can borrow some content from [...]

As long as we're not plagiarizing, that sounds excellent :-)

@stale
Copy link

stale bot commented Apr 29, 2017

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.

@ErikSchierboom
Copy link
Member

Fixed by #348.

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