Where can I find comprehensive documentation?

Open
#3,597 2 comments 8 reactions 0 assignees View on GitHub

Maintainers usually reply within 3 days

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
angular, typescript
Domain
documentation

Research direction

The issue names no specific files or tests. Start by reviewing the existing AngularFire Markdown documentation and comparing its compat and current-model guidance with the Firebase documentation; done means a clear source for migrating from v6 compat and distinguishing AngularFire imports from direct Firebase calls.

Written by the indexing model from the issue text.

Description

Where can I find thorough documentation on angular/fire? I first started using angular/fire about 2 years ago. Super confusing. The articles on the web are all over the place, mixing compat with the current model, some saying stay on compat (assume they were old articles), some intermixing angular/fire with straight google firebase calls (which this library is supposed to wrap, correct?). Even this site sends the user back to the google firebase side. Because of this, as a newbie a couple of years ago, I ended up intermingling my code, sometimes using angular/fire/compat, mixing in angular/fire, and other times importing straight from firebase. I eventually "got it", but again, super confusing.

So, now I am replacing my old v6 compat with the new model, but I cannot find simple documentation. The md's on this site are minimal. Is there a place that I am just over looking that is a good source for angular/fire documentation.

Thanks!

Dominant language
TypeScript
Stars
7.8k
Forks
2.1k
Avg merge
2d 22h
Merged PRs (30d)
25

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from angular/angularfire

All issues in angular/angularfire

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.