Skip to content

Divide the packages by category in the left sidebar #1118

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

Open
Sfshaza opened this issue Mar 2, 2016 · 8 comments
Open

Divide the packages by category in the left sidebar #1118

Sfshaza opened this issue Mar 2, 2016 · 8 comments
Labels
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

@Sfshaza
Copy link

Sfshaza commented Mar 2, 2016

Perhaps:

COMMON LIBRARIES
dart:async
dart:core
etc

HTML LIBRARIES
dart:html
etc

I/O LIBRARIES
dart:io
etc

@kwalrath

@sethladd
Copy link
Contributor

sethladd commented Mar 2, 2016

common to what? :)

@devoncarew devoncarew added the type-enhancement A request for a change that isn't a bug label Apr 7, 2016
@devoncarew
Copy link
Member

Flutter has ~37 libraries in its main doc page now: http://docs.flutter.io/flutter/. We could benefit from some type of categorization. Perhaps something like --use-package-categories, which would roll-up the various libraries by the source package? That would help in our case.

@jcollins-g
Copy link
Contributor

How is this different from --use-categories? It is a little wonky in edge cases but tries to do that.

@kwalrath
Copy link
Contributor

Do we have docs/examples for --use-categories, @jcollins-g? I looked around but didn't find them.

The last time I looked into this, I wanted to be able to have arbitrary groupings of libraries (like the ones Shams proposed), and I couldn't figure out how to do it.

@jcollins-g
Copy link
Contributor

http://docs.flutter.io uses --use-categories. Without it the left column on that page would be a flat list of libraries. It's generated by a script in flutter.

@jcollins-g jcollins-g added the P3 A lower priority bug or feature request label May 15, 2017
@jcollins-g
Copy link
Contributor

Changes to the new dartdoc in 0.11.0 include a --category-order flag which can give you some control over where libraries appear, but it might not be quite what this is looking for.

@devoncarew devoncarew 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 25, 2017
@chalin
Copy link
Contributor

chalin commented Apr 4, 2018

So I believe that part (all?) of this has landed, judging from the looks of https://api.dartlang.org/dev:

screen shot 2018-04-04 at 06 22 35

Elsewhere, @kwalrath wrote:

I'm wondering if the API docs should label the top group... it's hard to describe which libraries you can use in web apps, except by saying "non-VM" (and vice versa). ...

The original comment of this issue suggested a category name ("Common") for the top-level group. Could we have a category name for this group? Maybe one of:

  • Common or
  • Core or
  • Shared or maybe
  • Cross-platform?

cc @kevmoo

@jcollins-g
Copy link
Contributor

Looks like #1610 is a duplicate of this.

The current implementation is malleable; it's possible to for me to add a configuration option in dartdoc_options.yaml that defines the name of the default category.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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

6 participants