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

FR: Offline Documentation #5006

Open
Wildchild9 opened this issue Mar 3, 2020 · 1 comment
Open

FR: Offline Documentation #5006

Wildchild9 opened this issue Mar 3, 2020 · 1 comment

Comments

@Wildchild9
Copy link

@Wildchild9 Wildchild9 commented Mar 3, 2020

Right now, I am writing an app in Swift with Firebase and am finding the documentation hard to work with. First off, all of the documentation is for Objective C so I always need to try to translate it upon reading to its Swift equivalent:

Screen Shot 2020-03-03 at 10 56 15 AM

Because this is really hard to use, I frequently make use of the iOS - Swift online documentation. Since I often work offline though, I am usually stuck with the not-very-helpful Objective C quick help documentation. For certain libraries with similar problems, I use their supported documentation on Dash for offline usage.

I would like to propose the creation of a Dash docset for Firebase so people can view the documentation offline. While I primarily care about Swift since it is the language I am writing in, Firebase could potentially provide all documentation of its documentation for all of its supported platforms through Dash.

Also, on a side note, while I am not sure if it is even possible, it would be great to have native Swift documentation for Firebase. I rely on the quick help documentation often and having it readable to Swift developers would be a big bonus.

@morganchen12
Copy link
Contributor

@morganchen12 morganchen12 commented Mar 3, 2020

Moving the reference documentation annotations to Swift syntax is a good idea given most ObjC developers are familiar with Swift but not all Swift developers are familiar with ObjC.

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

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.