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

Surface category one liner on index page #3632

Merged
merged 4 commits into from
Jan 24, 2024

Conversation

parlough
Copy link
Member

@parlough parlough commented Jan 22, 2024

Surface the first line of category documentation on the documentation index page.

Contributes to #3618, by enabling the first line a category/topic's documentation to show up on the index page. If a category does not have a documentation page (such as the Dart SDK's categories), this doesn't change anything.

Example from test_package index page:

Example of surfaced category

@srawlins
Copy link
Member

This is great! Can you paste what this does to the Dart SDK docs (which I think use categories for "web", "VM", etc.)?

@parlough
Copy link
Member Author

parlough commented Jan 23, 2024

I've updated the PR description to expand a bit, but this won't affect those categories yet.

As far as I understand, a category with documentation is treated like a topic, but I don't know if we want to treat those categories as topics in the SDK docs. So some mechanism needs to be introduced that prevents a category with documentation being treated as topic, while still having documentation. I haven't determined the best path forward yet, so am open to suggestions!

I thought landing this would be a good first step, as it benefits categories that already are topics. Then hopefully we can build on this for simpler categories like in the SDK :)

@srawlins
Copy link
Member

OK, so this change would not add any text to the api.dart.dev home page?

@parlough
Copy link
Member Author

OK, so this change would not add any text to the api.dart.dev home page?

Correct. As those categories don't have any descriptions.

@srawlins srawlins merged commit f895c61 into dart-lang:main Jan 24, 2024
9 checks passed
@parlough parlough deleted the feat/surface-category-description branch January 24, 2024 23:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants