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

Expand 'Using JSON' page into a proper guide for JSON #4286

Open
parlough opened this issue Oct 15, 2022 · 1 comment
Open

Expand 'Using JSON' page into a proper guide for JSON #4286

parlough opened this issue Oct 15, 2022 · 1 comment
Labels
a.reference Relates to reference material section of dart.dev d.enhancement Improves docs with specific ask e2-days Can complete in < 5 days of normal, not dedicated, work p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged

Comments

@parlough
Copy link
Member

parlough commented Oct 15, 2022

Page URL

https://dart.dev/guides/json

Page source

https://github.com/dart-lang/site-www/tree/main/src/_guides/json.md

Describe the problem

Right now our JSON page just links to other resources. We should expand on this, perhaps with some similar content to Flutter's JSON and serialization page. This is a next step for a full update of the fetching data page: #4520

Expected fix

Update the JSON page, with further inline documentation about utilities and packages such as dart:convert, package:json_serializable, package:built_value, package:freezed, etc.

Additional context

No response

@parlough parlough added d.enhancement Improves docs with specific ask p1-high Major but not urgent concern: Resolve in months. Update each month. a.tut.tutorial Relates to the Tutorial section of dart.dev docs e1-hours Can complete in < 8 hours of normal, not dedicated, work e2-days Can complete in < 5 days of normal, not dedicated, work labels Oct 15, 2022
@parlough parlough added p2-medium Necessary but not urgent concern. Resolve when possible. and removed p1-high Major but not urgent concern: Resolve in months. Update each month. labels Jan 31, 2023
@atsansone atsansone added st.triage.ltw Indicates Lead Tech Writer has triaged a.reference Relates to reference material section of dart.dev and removed docs e1-hours Can complete in < 8 hours of normal, not dedicated, work a.tut.tutorial Relates to the Tutorial section of dart.dev labels Apr 29, 2023
@atsansone atsansone changed the title [PAGE ISSUE]: 'Using JSON' - Provide proper guide for JSON Expand 'Using JSON' page into a proper guide for JSON May 3, 2023
@MaryaBelanger
Copy link
Contributor

Update / clarifying the conversation in #5605:

One goal is to consolidate Dart-specific JSON serialization content on the existing JSON page.

This likely means moving* Dart-specific content from the JSON and serialization page on flutter.dev to dart.dev, since the topic revolves around Dart features and packages.

This is important because, as Dart's JSON serialization story develops, it's important that the source of truth on the topic is clear and distinct.

*Probably doesn't mean removing the entire page, but at minimum transferring the core concepts. The Flutter page can point to the Dart page for "prerequisites".

@parlough let me know if this comment aligns with your thoughts and feel free to edit it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a.reference Relates to reference material section of dart.dev d.enhancement Improves docs with specific ask e2-days Can complete in < 5 days of normal, not dedicated, work p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged
Projects
None yet
Development

No branches or pull requests

3 participants