Skip to content

We'd like to link from API docs back to the product homepage #1460

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

Closed
sethladd opened this issue Jun 15, 2017 · 4 comments
Closed

We'd like to link from API docs back to the product homepage #1460

sethladd opened this issue Jun 15, 2017 · 4 comments
Assignees
Labels
customer-flutter Issues originating from important to Flutter 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

@sethladd
Copy link
Contributor

Currently, the dartdoc output puts the package/product name into the upper left of the page. Which is cool. Except, we won't think we have an easy way to link that name to somewhere relevant.

We can post-process the docs, but would be cool if I could ask dartdoc to link the title in the upper-left of the page.

@jcollins-g jcollins-g self-assigned this Jun 15, 2017
@jcollins-g jcollins-g added P2 A bug or feature request we're likely to work on customer-flutter Issues originating from important to Flutter type-enhancement A request for a change that isn't a bug labels Jun 15, 2017
@jcollins-g
Copy link
Contributor

The obvious thing to try here is adding support for the homepage: link in pubspec.yaml and link this field to that when it is present. I'll try that and see how well it works.

@sethladd
Copy link
Contributor Author

Ah, good idea!

@jcollins-g
Copy link
Contributor

This seems to work alright, but given that the package name is already in use to return readers of other API pages to the index, #1463 only changes this for the package index page.

@sethladd
Copy link
Contributor Author

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
customer-flutter Issues originating from important to Flutter 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

2 participants