fsprojects / fsprojects/FSharpPlus
Improve docs
Nobody has claimed this yet.
- Dominant language
- F#
- Stars
- 941
- Forks
- 106
- PR merge metrics
- No merged PRs in 30d
Description
I opened this issue to discuss how can we improve the docs.
It's very valuable the input from users, as I have a deep knowledge of the library already, so my view doesn't help a lot.
We can start compiling a list of things we need to add, like another tutorial, some how-to sections, a better readme or doc home page and so on.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue does not name files or tests. Start by reviewing the existing README, documentation home page, tutorials, and how-to sections mentioned in the discussion; done first requires an agreed list of documentation gaps and a defined scope for the requested improvements.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fsharp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100