Skip to content

Categorize dart:* libraries on api.dartlang.org #32297

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.

Sign up for GitHub

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

Jump to bottom
Closed
kevmoo opened this issue Feb 23, 2018 · 12 comments
Closed

Categorize dart:* libraries on api.dartlang.org #32297

kevmoo opened this issue Feb 23, 2018 · 12 comments
Assignees
@jcollins-g
Labels
area-documentation Prefer using 'type-documentation' and a specific area label. area-infrastructure Use area-infrastructure for SDK infrastructure issues, like continuous integration bot changes. area-sdk Use area-sdk for general purpose SDK issues (packaging, distribution, …). P1 A high priority bug; for example, a single project is unusable or has many test failures
Milestone
Dart2 Beta 3

Comments

@kevmoo
Copy link
Member

kevmoo commented Feb 23, 2018 •
edited
Loading

The current layout is flat. It's not clear which APIs are usable where.

https://api.dartlang.org/be/154136/index.html

We should group these:

  • Core
    • everything not called out below
  • VM
    • io
    • cli
  • Web
    • html
    • indexed_db
    • js
    • js_util
    • svg
    • web_*

Flutter does a good job here: https://docs.flutter.io/
@kevmoo kevmoo added area-documentation Prefer using 'type-documentation' and a specific area label. area-infrastructure Use area-infrastructure for SDK infrastructure issues, like continuous integration bot changes. area-sdk Use area-sdk for general purpose SDK issues (packaging, distribution, …). labels Feb 23, 2018
@kevmoo
Copy link
Member Author

kevmoo commented Feb 23, 2018

@jcollins-g – how hard is this to setup?

CC @whesse

@kevmoo kevmoo added this to the 2.0-alpha2 milestone Feb 23, 2018
@jcollins-g
Copy link
Contributor

jcollins-g commented Feb 23, 2018 •
edited
Loading

There are command line flags to dartdoc to organize packages as subcategories, but there is no subpackage categorization, which is what you're asking for here.

@kevmoo
Copy link
Member Author

kevmoo commented Feb 23, 2018

@jcollins-g – does this become a feature request for dartdoc then?

@jcollins-g
Copy link
Contributor

Yes.

@kevmoo kevmoo mentioned this issue Feb 23, 2018
Closed
@kevmoo
Copy link
Member Author

kevmoo commented Feb 23, 2018

Blocked by dart-lang/dartdoc#1610

@kevmoo kevmoo added status-blocked Blocked from making progress by another (referenced) issue P1 A high priority bug; for example, a single project is unusable or has many test failures labels Feb 23, 2018
@devoncarew
Copy link
Member

Here is how flutter does it: https://github.com/flutter/flutter/blob/master/dev/tools/dartdoc.dart#L119

@jcollins-g
Copy link
Contributor

Talked offline, but to recap, flutter depends on categories aligning to packages. Within a package (e.g. the SDK), that's a new feature.

@dgrove
Copy link
Contributor

dgrove commented Mar 20, 2018

@jcollins-g Can you please move to a current milestone (Dart2 beta3/beta4/stable)?

@kevmoo kevmoo modified the milestones: 2.0-alpha2, Dart2 Beta 4 Mar 20, 2018
@jcollins-g
Copy link
Contributor

I believe @kevmoo already did this.

@kevmoo
Copy link
Member Author

kevmoo commented Mar 20, 2018 via email

@kevmoo
Copy link
Member Author

kevmoo commented Mar 26, 2018

Dartdoc fix landed in dart-lang/dartdoc@628acf6 - which is in 0.18.0

@kevmoo kevmoo removed the status-blocked Blocked from making progress by another (referenced) issue label Mar 26, 2018
@kevmoo kevmoo modified the milestones: Dart2 Beta 4, Dart2 Beta 3 Mar 26, 2018
dart-bot pushed a commit that referenced this issue Mar 27, 2018
@jcollins-g
Update dartdoc to v0.18.0 and tag library categories.
f386b36 
Bug: #32297
Change-Id: Id99c98c1b908c5a4b42594cd7e73cd92e089bbca
Reviewed-on: https://dart-review.googlesource.com/48450
Commit-Queue: Janice Collins <[email protected]>
Reviewed-by: Devon Carew <[email protected]>
Reviewed-by: William Hesse <[email protected]>
@kevmoo
Copy link
Member Author

kevmoo commented Mar 27, 2018

Fixed in f386b36

@kevmoo kevmoo closed this as completed Mar 27, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jcollins-g jcollins-g

Labels
area-documentation Prefer using 'type-documentation' and a specific area label. area-infrastructure Use area-infrastructure for SDK infrastructure issues, like continuous integration bot changes. area-sdk Use area-sdk for general purpose SDK issues (packaging, distribution, …). P1 A high priority bug; for example, a single project is unusable or has many test failures
Projects
None yet
Milestone
Dart2 Beta 3
Development

No branches or pull requests
4 participants
@kevmoo @devoncarew @dgrove @jcollins-g