Recommended API Version
- Dominant language
- TypeScript
- Stars
- 7.8k
- Forks
- 2.2k
- Avg merge
- 22h 28m
- Merged PRs (30d)
- 6
Description
First, the [Example Use](https://github.com/angular/angularfire#developer-guide) section of the README has examples using the Modular API. Then, in the [Resources](https://github.com/angular/angularfire#resources) section of the README, we're first directed to the [version 7 upgrade guide](https://github.com/angular/angularfire/blob/master/docs/version-7-upgrade.md) that specifically mentions in bolded text:
> **Most developers can stop here for now as the new API isn't feature complete.**
Finally, the README then proceeds to the [Developer Guide](https://github.com/angular/angularfire#developer-guide) section that again links to the upgrade doc, but then specifically calls out that it assumes we're using the Modular API. Even the new issue instructions recommend that we read said Developer Guide, indicating that perhaps the Modular API should be what we're using.
While I would like a direct answer as to which is the currently recommended version, I'm guess that it's the Modular API and that the version 7 upgrade document is out of date. If that's correct, and the Modular API is now feature complete, then it should be updated to prevent this type of confusion.
Contributor guide
Research direction
Compare the README's Example Use, Resources, and Developer Guide sections with docs/version-7-upgrade.md, especially the statements about the Modular API being incomplete. Confirm the currently recommended API with project maintainers, then make the README and upgrade guide consistent and verify that the conflicting guidance is gone.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- angular, firebase, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100