Skip to content

Commit fe5e68c

Browse files
committed
Restructure docs for KTX
1 parent 2c1ffe7 commit fe5e68c

File tree

3 files changed

+46
-6
lines changed

3 files changed

+46
-6
lines changed

.opensource/project.json

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,22 @@
44
"platforms": [
55
"Android"
66
],
7-
"content": "README.md",
8-
"pages": [
9-
"firebase-common/README.md",
10-
"firebase-firestore/README.md",
11-
"protolite-well-known-types/README.md"
12-
],
7+
"content": "docs/README.md",
8+
"pages": {
9+
"README.md": "Development Guide",
10+
"docs/ktx/firestore.md": "Firestore KTX"
11+
},
1312
"related": [
1413
"firebase/quickstart-android"
14+
],
15+
"tabs": [
16+
{
17+
"title": "Main Reference",
18+
"href": "https://firebase.google.com/docs/reference/android/"
19+
},
20+
{
21+
"title": "KTX Reference",
22+
"href": "https://firebase.github.io/firebase-android-sdk/reference/kotlin/firebase-ktx/"
23+
}
1524
]
1625
}

docs/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Firebase Android SDK
2+
3+
The Firebase SDK for Android is the official way to add Firebase to your
4+
Android app. To get started, visit the [setup instructions][android-setup].
5+
6+
## Open Source
7+
8+
The following Firebase SDKs for Android are developed in this
9+
repository:
10+
11+
* `firebase-common`
12+
* `firebase-database`
13+
* `firebase-firestore`
14+
* `firebase-functions`
15+
* `firebase-inappmessaging-display`
16+
* `firebase-storage`
17+
18+
For more information on building the SDKs from source or contributing,
19+
visit the [main README][main-readme].
20+
21+
## Kotlin Extensions
22+
23+
24+
25+
[android-setup]: https://firebase.google.com/docs/android/setup
26+
[main-readme]: https://github.com/firebase/firebase-android-sdk/blob/master/README.md

docs/ktx/firestore.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Firestore Kotlin Extensions
2+
3+
```
4+
// TODO: Finish this page
5+
```

0 commit comments

Comments
 (0)