Better Language Documentation as a whole package for newcomers

Open
#760 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
fsharp
Domain
documentation

Research direction

Start by reviewing the current resources linked from fsharp.org/learn.html and compare their organization, freshness, and assumptions with the examples cited in the issue. The scope needs to be narrowed into an agreed learning path or set of pages before work can be considered done.

Written by the indexing model from the issue text.

Description

I am a newbie in F# with strong Python background, trying to do some real-world projects to get a good feel of F#.
When I started learning F#, it wasn't a smooth experience. The reason I think are the scattered learning resources and there was no clear path to learn all the basic language constructs.

I have tried some sites suggested in https://fsharp.org/learn.html and they are cluttered and assume that the learner is from C# ecosystem. The books are outdated(using VS and not .NET Core). Other modern languages have great documentation in its main website itself. It gears up the great learning feel.
For example

everything in one place up-to-date and serves as a reference whenever needed during the initial phases of learning curve.

Here I really like the docs of ReasonML which clearly have organized all the topics. I think many people have felt the same and off-putting to learn F#.
Is it possible to clearup the current documentation of the site? I will be more than happy to work on new pages and would translate from ReasonML for F#. But I am no expert in F# as I mentioned before.

Dominant language
TeX
Stars
311
Forks
291
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from fsharp/fsharp.org

All issues in fsharp/fsharp.org

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.