firebase / firebase/firebase-ios-sdk

FR: Offline Documentation

Open
#5,006 4 comments 0 reactions 1 assignee Claimed by @morganchen12 View on GitHub
Docs type: feature request
Dominant language
C++
Stars
6.7k
Forks
1.8k
Avg merge
2d 18h
Merged PRs (30d)
75

Description

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](https://firebase.google.com/docs/reference/swift/firebasecore/api/reference/Classes). 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](https://kapeli.com/dash) for offline usage.

I would like to propose the creation of a [Dash docset](https://kapeli.com/docsets) 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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.