Skip to content

FR: Source maps for docs #72

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

Open
samtstern opened this issue Jun 6, 2017 · 5 comments
Open

FR: Source maps for docs #72

samtstern opened this issue Jun 6, 2017 · 5 comments

Comments

@samtstern
Copy link
Contributor

Add a source map to the doc generation process so that reference docs can link directly into source files for each function/constant/etc.

@paulb777
Copy link
Member

paulb777 commented May 4, 2018

@samtstern Please provide more context? Where is the doc generation process that you're referring to?

@samtstern
Copy link
Contributor Author

This was a long time ago so I don't remember all the context. The idea was that the reference docs (ex: FirebaseApp) could have a "View Source" button that would link you directly into this repository.

For instance the Android platform documentation has this feature, and I've found it really useful:
yalxfhrjmkv

@alexg33
Copy link
Contributor

alexg33 commented Jul 10, 2018

@samtstern — Not seeing that "View Source" button when I look at the doc. Where does it send you if you click the link? (You might have special, special access.)

@samtstern
Copy link
Contributor Author

@alexg33 whoops! Looks like I only have that because of this extension:
https://chrome.google.com/webstore/detail/android-sdk-search/hgcbffeicehlpmgmnhnkjbjoldkfhoin

Well either way, it's something we can/should add.

@alexg33
Copy link
Contributor

alexg33 commented Jul 10, 2018

Well, per usual, you're right.

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

No branches or pull requests

5 participants