Skip to content

Request to group concepts together, across libraries #1353

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

Closed
sethladd opened this issue Mar 20, 2017 · 9 comments
Closed

Request to group concepts together, across libraries #1353

sethladd opened this issue Mar 20, 2017 · 9 comments
Labels
customer-flutter Issues originating from important to Flutter P2 A bug or feature request we're likely to work on type-enhancement A request for a change that isn't a bug

Comments

@sethladd
Copy link
Contributor

Related to flutter/flutter#8906

We'd like to:

  • somehow say "these concepts are all part of the same concept/category/grouping"
  • somehow say "this is the homepage for that concept"
@sethladd sethladd added the customer-flutter Issues originating from important to Flutter label Mar 20, 2017
@jcollins-g
Copy link
Contributor

Would like to know more here. This sounds like you want something (A comment? A separate file?) that declares a "concept" with a description or similar. The closest thing dartdoc does similar to this is the top level index for a package, so my first inclination would be to generate something that looks like that. If we see this concept referenced via a decorator or similar for a particular identifier, cross-link that identifier with the concept's top level page.

You could sort of do that now with an arbitrary decorator you declare for the concept, say @MyConcept. And in @MyConcept's doc you could describe the concept. But that would only link one direction right now, I think.

@jcollins-g jcollins-g added P3 A lower priority bug or feature request type-enhancement A request for a change that isn't a bug labels Apr 14, 2017
@jcollins-g jcollins-g added P2 A bug or feature request we're likely to work on and removed P3 A lower priority bug or feature request labels May 15, 2017
@Hixie
Copy link
Contributor

Hixie commented May 25, 2017

@sethladd, @InMatrix - can you give @jcollins-g a sketch of what you are hoping we can do here?

@InMatrix
Copy link

InMatrix commented May 25, 2017

We would love to be able to annotate an API's category and subcategory in its source code and generate a file similar to the hand-crafted widgets.json, which backs the widget catalog. Some of the categories are across library boundaries such as "layout models."

@InMatrix
Copy link

@sethladd did you envision other use of the categorization mechanism discussed here? On second thought, keeping widgets.json updated is not too bad. So I'm not sure if it's worth pursuing a more sophisticated solution.

@jcollins-g
Copy link
Contributor

Ah. So, you're not actually looking for a front-page for the concept, but rather for dartdoc to generate jsons using the custom annotation you described?

@sethladd
Copy link
Contributor Author

@Hixie if you can add a category and subcategory annotation to widgets, we can extract out a beautiful widget catalog and look at dartdoc organization options, as @InMatrix suggests.

I opened flutter/flutter#10344 to ask for a solution in the source code. From there, we can look at display options.

@InMatrix
Copy link

This feature will be especially useful to show animation-related widgets in a single place. They are currently scattered in the Animation library, the Material library, and the Widget library.

@jcollins-g
Copy link
Contributor

Work for #1610 is putting this feature within reach. A tag inside the documentation for a symbol will be able to add it to a category. The structure built for #1610 just needs to be extended to more symbol types.

@jcollins-g
Copy link
Contributor

This is actually complete as of a couple versions ago.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
customer-flutter Issues originating from important to Flutter P2 A bug or feature request we're likely to work on type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

No branches or pull requests

4 participants