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

Update or remove 'Converters and codecs' article #5175

Open
parlough opened this issue Sep 16, 2023 · 2 comments
Open

Update or remove 'Converters and codecs' article #5175

parlough opened this issue Sep 16, 2023 · 2 comments
Labels
a.libraries Relating to the Dart standard libraries. e2-days Can complete in < 5 days of normal, not dedicated, work e3-weeks Complete in < 4 weeks of normal, not dedicated, work meta.outdated Need to update content due to content or product obsolence p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. st.triage.ltw Indicates Lead Tech Writer has triaged

Comments

@parlough
Copy link
Member

parlough commented Sep 16, 2023

Page URL

https://dart.dev/articles/archive/converters-and-codecs

Page source

https://github.com/dart-lang/site-www/tree/main/src/_articles/archive/converters-and-codecs.md

Describe the problem

The article has been marked as obsolete for a long time, but still is hosted and provides valuable information.

Expected fix

Either remove the article or update it for modern standards:

  • Remove extra "article information (publish date, up-front authors, etc)
  • Update text and code samples for modern Dart language (^3.4) and library changes
    • Also use newer lints and analyzer language modes
  • Add code excerpts and tests for code samples
  • Reduce amount of long text (more focused)
  • Copy edit and update for modern GSG/our writing guidelines
  • Update formatting/style for our current site guidelines
  • After previous steps, remove the obsolete
  • Find home in sidenav
@parlough parlough added a.libraries Relating to the Dart standard libraries. p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. e2-days Can complete in < 5 days of normal, not dedicated, work e3-weeks Complete in < 4 weeks of normal, not dedicated, work meta.outdated Need to update content due to content or product obsolence labels Sep 16, 2023
@atsansone atsansone added the st.triage.ltw Indicates Lead Tech Writer has triaged label Sep 30, 2023
@parlough
Copy link
Member Author

parlough commented May 7, 2024

@lrhn This old Converters and codecs article has been sitting, marked as obsolete, on the site for a long time now with outdated samples and perhaps inaccurate text.

Do you think you could take a quick look to see if it's worth me updating and cleaning it up? Or better to just drop in its current state?

@lrhn
Copy link
Member

lrhn commented May 8, 2024

A quick look at the article doesn't show anything particularly wrong. The JsonCodec part mentions the toEncodable parameter, which I think was the most recent change, so it's probably up-to-date.

It's not a library that has had many changes.
I think there are places where I'd phrase things differently, or maybe focus differently, but the actual content is fine. It's not because anything is outdated.

Are you aware of any particular issues with the content?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a.libraries Relating to the Dart standard libraries. e2-days Can complete in < 5 days of normal, not dedicated, work e3-weeks Complete in < 4 weeks of normal, not dedicated, work meta.outdated Need to update content due to content or product obsolence p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. st.triage.ltw Indicates Lead Tech Writer has triaged
Projects
None yet
Development

No branches or pull requests

3 participants