Skip to content
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

Enable specifying a Markdown description of a category #3618

Open
parlough opened this issue Jan 12, 2024 · 3 comments
Open

Enable specifying a Markdown description of a category #3618

parlough opened this issue Jan 12, 2024 · 3 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

@parlough
Copy link
Member

parlough commented Jan 12, 2024

Then we can add descriptions on the API docs overview/index page: https://api.dart.dev/main

This would allow us to explain what the categories actually mean and why they exist. For example:

  • That "Core" libraries should work across all platforms
  • That "VM" libraries only work when ran or compiled for native platforms
  • That usage of "WEB (LEGACY)" libraries should be migrated (and what to)
  • Perhaps more :)

While a normal string would be sufficient, supporting Markdown here would be great as it would enable easy links.

@parlough
Copy link
Member Author

parlough commented Jan 12, 2024

\cc @devoncarew Since you're modifying the categories now, what do you think?

This could show up below the relevant headers on the index page:

New legacy category

@devoncarew
Copy link
Member

Yeah, I think this would be great - it would give more context to the categories.

We can manually describe things in the markdown above the generated list, but messaging things more than once can be useful.

@srawlins
Copy link
Member

I think I got mixed up, but this is still not implemented, right? I think @devoncarew landed something separate, which enabled package:web to be listed in the Web category of the Dart SDK, right?

@srawlins srawlins added the P2 A bug or feature request we're likely to work on label Feb 28, 2024
@srawlins srawlins added the type-enhancement A request for a change that isn't a bug label Mar 13, 2024
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

3 participants