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

Embed Dartdoc inside the documentation #3755

Open

rrousselGit opened this issue Sep 21, 2024 · 0 comments

Assignees

Labels

Owner

rrousselGit commented Sep 21, 2024

Riverpod provides DartDoc for all of its APIs: https://pub.dev/documentation/riverpod/latest/riverpod/riverpod-library.html

This is a good way to:

find new APIs
learn about the inner workings of a specific API

But most people looking for such information instead go to riverpod.dev ; and fail to find the API reference.

We should find a way to extract Dartdoc and place it inside riverpod.dev itself.

rrousselGit added documentation needs triage labels

rrousselGit self-assigned this

rrousselGit removed the needs triage label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment