Skip to content

Asset documentation should have a simple intro. #4927

Closed

Description

@dragostis

The documentation for assets should be clear and more to the point, with details about usage coming up later. For example, Specifying assets speaks about assets and paths inside the flutter.yaml before talking about the assets folder.

A simpler way might be:

We usually use the assets folder for assets. You need to specify them inside the flutter.yaml:

Also, we should probably have a very simple example of how to use an image asset closer to the top of the document.

Activity

  1. eseidelGoogle commented on Jul 15, 2016

    @eseidelGoogle
    Contributor

    @qchong is most informed about our high-level docs. I'm not sure if he authored the assets doc in particular.

  2. HansMuller commented on Jul 15, 2016

    @HansMuller
    Contributor

    Also, we should probably have a very simple example of how to use an image asset closer to the top of the document.

    I agree. For common questions like this one (how to do I incorporate an image in my app) a brief example is probably all that most developers will need.

  3. modified the milestone: on Sep 12, 2016
  4. modified the milestones: , on Jan 31, 2017
  5. modified the milestones: 3: Current Milestone, , on Nov 21, 2017
  6. Hixie commented on May 22, 2018

    @Hixie
    Contributor

    I believe this is mostly done now.

  7. github-actions commented on Aug 15, 2021

    @github-actions

    This thread has been automatically locked since there has not been any recent activity after it was closed. If you are still experiencing a similar issue, please open a new bug, including the output of flutter doctor -v and a minimal reproduction of the issue.

  8. locked as resolved and limited conversation to collaborators on Aug 15, 2021
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

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions