dotnet / dotnet/docs

System.Text.Json - Documentation revisions to lower entry point

Open
#30,506 0 comments 0 reactions 1 assignee Claimed by @gewarren View on GitHub
dotnet-fundamentals/svc
Dominant language
No language data
Stars
4.8k
Forks
6.1k
Avg merge
19h 10m
Merged PRs (30d)
268

Description

Please consider revisiting these demos/docs for a more consistent/clear theme. Particularly the relationship between:
- JsonElement (JsonObject, JsonArray, etc...)
- JsonNode
- JsonDocument

Pros/Cons of each. Right now it just seems like a random collection of static methods.

Avoid examples like this without justification (or at least unambiguous variable names):
JsonNode document = JsonNode.Parse(jsonString)!;

This does not exclusively apply to this page, but rather to the entire System.Text.Json namespace documentation.

[Enter feedback here]

---
#### Document Details

⚠ *Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.*

* ID: 73a13d38-4904-c068-c9eb-e43176ce5338
* Version Independent ID: c5dfa4d2-c77a-e752-dae7-0bfae5756b76
* Content: [How to use a JSON document, Utf8JsonReader, and Utf8JsonWriter in System.Text.Json](https://docs.microsoft.com/en-us/dotnet/standard/serialization/system-text-json-use-dom-utf8jsonreader-utf8jsonwriter?pivots=dotnet-6-0)
* Content Source: [docs/standard/serialization/system-text-json-use-dom-utf8jsonreader-utf8jsonwriter.md](https://github.com/dotnet/docs/blob/main/docs/standard/serialization/system-text-json-use-dom-utf8jsonreader-utf8jsonwriter.md)
* Product: **dotnet-fundamentals**
* GitHub Login: @gewarren
* Microsoft Alias: **gewarren**

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.