Skip to content

Conversation

@jhuleatt
Copy link
Collaborator

@jhuleatt jhuleatt commented Jan 31, 2020

Now that we better support lazy loading, as well as React's preload/render-as-you-fetch pattern, it is time to update the docs.

Preview here

Changes

  • Add init instructions to usage docs
  • Update quickstart samples to promote lazy loading and adopt React render-as-you-fetch pattern
  • Update samples to use ReactDOM.createRoot
  • Decide whether we still want the quickstart, and, if so, update it with some render-as-you-fetch explanation (note: I decided against mentioning this in the quickstart, and instead added it to the usage docs)
  • Update the "common use cases" section
    • Read data from Firestore only when a user is logged in
    • Log page views with Analytics
    • How to solve Warning: App triggered a user-blocking update that suspended. with useTransition
      - [ ] Something with Remote Config (note: going to save this for another day)
    • Log page views with Google Analytics for Firebase
    • document useObservable for advanced use cases
  • Update "What is ReactFire" in readme to emphasize lazy loading
  • Double check that CONTRIBUTING.md is up to date

Stretch Goals

- [ ] Auto-generate reference docs from source

README.md Outdated
> [here](https://github.com/FirebaseExtended/reactfire/tree/v1.0.0)
**Status: Alpha**. ReactFire is meant for React Concurrent Mode, which is only
⚠️ **Status: Alpha**. ReactFire is meant for React Concurrent Mode, which is only
Copy link
Collaborator

Choose a reason for hiding this comment

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

How about "status: experimental". We should also add that "we will aim to be API Stable, however"

@jhuleatt jhuleatt merged commit 32c2bb3 into master Feb 25, 2020
@jhuleatt jhuleatt deleted the jh-docs branch February 25, 2020 19:49
@jhuleatt jhuleatt changed the title [WIP] Docs updates 📚 Docs updates 📚 Feb 25, 2020
@FirebaseExtended FirebaseExtended locked and limited conversation to collaborators Dec 8, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants