fsprojects / fsprojects/FsHttp
JSON Docu
Open
Nobody has claimed this yet.
documentation
enhancement
- Dominant language
- F#
- Stars
- 498
- Forks
- 41
- PR merge metrics
- No merged PRs in 30d
Description
Better docu for working with JSON
- Explain some JSON extensions for SystemTextJson (like GetList() )
- The JSON Api can be shadowed for Newtonsoft + FSHarp.Data
- Working with dynamic JSON with all 3 JSON APIs
Aside from docu: The API is a little bit verbose, and we could think about introducing some useful daily-work shortcuts, like:
- json.GetList("children"), etc.
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
Start by locating the documentation and entry points for the three JSON APIs named in the issue: System.Text.Json, Newtonsoft, and FSharp.Data. Compare their extension and dynamic-JSON usage; done means the requested JSON workflows and API differences are documented, with any shortcut ideas clearly separated as follow-up work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fsharp
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100