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

docs(readme): tag realtime db + add firestore db #857

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

rtpHarry
Copy link

The docs for the database point to the realtime database. There doesn't seem to be any mention of Firestore in the docs, but looking in the source code, it exists and just passes it through to the @google-cloud/firestore package.

The docs for the database point to the realtime database. There doesn't seem to be any mention of Firestore in the docs, but looking in the source code, it exists and just passes it through to the `@google-cloud/firestore` package.
Copy link
Contributor

@hiranya911 hiranya911 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest we point to the actual Firestore guide on the website rather than the API reference.

@@ -67,7 +67,8 @@ environments.
## Documentation

* [Setup Guide](https://firebase.google.com/docs/admin/setup/)
* [Database Guide](https://firebase.google.com/docs/database/admin/start/)
* [Realtime Database Guide](https://firebase.google.com/docs/database/admin/start/)
* [Firestore Guide](https://googleapis.dev/nodejs/firestore/latest/index.html)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should point to https://firebase.google.com/docs/firestore

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reason that I submitted this pr was because I was trying to get started with coding and the api for this library is different to the api used on the main docs. The PR is editable if you want to change the url.

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

Successfully merging this pull request may close these issues.

None yet

2 participants