Skip to content

[packages] Adopt code-excerpt across all READMEs #102679

Open

Description

@stuartmorgan-g

flutter-team-archive/plugins#5339 will add the ability to manage our README code snippets with code-excerpt so that they stop getting out of sync with changes in APIs, Dart, or lints, as well as sometimes just having typos that make them incorrect from the start. Once that lands we should start proactively updating all of our READMEs to use it, rather than waiting for bugs to be found, since it's a pretty easy change and will almost certainly find and fix latent issues in our READMEs given the steady stream of PRs we get about them.

That will also allow us to turn on enforcement in the repo to ensure that new code samples are written that way, so we don't create new documentation tech debt by accident.

Here's the list of exceptions we need to eliminate:

Activity

  1. changed the title [-][plugins] Adopt `code-excerpt` across all READMEs[/-] [+][plugins/packages] Adopt `code-excerpt` across all READMEs[/+] on Apr 29, 2022
  2. stuartmorgan-g commented on Apr 29, 2022

    @stuartmorgan-g
    ContributorAuthor

    We should do this for flutter/package as well; I'm adding the tooling support there now.

  3. stuartmorgan-g commented on Aug 15, 2022

    @stuartmorgan-g
    ContributorAuthor
  4. added
    packageflutter/packages repository. See also p: labels.
    and removed on Mar 6, 2023
  5. changed the title [-][plugins/packages] Adopt `code-excerpt` across all READMEs[/-] [+][packages] Adopt `code-excerpt` across all READMEs[/+] on Jun 21, 2023
  6. added
    d: api docsIssues with https://api.flutter.dev/
    on Jul 5, 2023
  7. 87 remaining items

  8. Bhagyaprasad92 commented on Oct 23, 2026

    @Bhagyaprasad92

    Hi! I'd like to work on the cupertino_ui item from this checklist by updating its README code examples to use code-excerpt,
    I'll first check the current repository conventions and existing examples, then submit a focused PR to flutter/packages,
    Please let me know if this item is already being handled or if there are any specific expectations I should follow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    P2Important issues not at the top of the work listc: contributor-productivityTeam-specific productivity, code health, technical debt.d: api docsIssues with https://api.flutter.dev/packageflutter/packages repository. See also p: labels.team-ecosystemOwned by Ecosystem teamtriaged-ecosystemTriaged by Ecosystem team

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions