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(app): install doc preening #8420

Merged
merged 3 commits into from
Mar 24, 2025
Merged

Conversation

mikehardy
Copy link
Collaborator

Description

Was in the area while doing something unrelated and once again realized how out of date some of our install docs sections are, plus there were some errors like a dangling internal page anchor

Fixed them all with separate commits so it's easy to review commit by commit - not that it is a huge PR anyway

Related issues

none logged, fixed rapidly while working on other things

Release Summary

docs commit tag(s), no release triggered
can squash merge

Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
    • Yes
  • My change supports the following platforms;
    • Android
    • iOS
    • Other (macOS, web)
  • My change includes tests;
    • e2e tests added or updated in packages/\*\*/e2e
    • jest tests added or updated in packages/\*\*/__tests__
  • I have updated TypeScript types that are affected by my change.
  • This is a breaking change;
    • Yes
    • No

Test Plan

if lint passes, it should be good to go


Think react-native-firebase is great? Please consider supporting the project with any of the below:

- headings increased by 2 from h2 to h4, should go one step at a time
- internal anchor was incorrect for CLI projects
- gradle 7.3+ has been default for quite some time
- multidex is not valid on android minSdk level in place for quite some time
- hermes works fine now and has for quite some time
- android build memory we suggested as a fix has been default fo rquite some time
- manual linking is history from another era
@mikehardy mikehardy added the Workflow: Needs Review Pending feedback or review from a maintainer. label Mar 24, 2025
Copy link

vercel bot commented Mar 24, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
react-native-firebase ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 24, 2025 2:16pm

@@ -201,13 +201,13 @@ To do this, open your `/ios/{projectName}/AppDelegate.mm` file (or `AppDelegate.

At the top of the file, import the Firebase SDK right after `'#import "AppDelegate.h"'`:

```
```objectivec
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think github uses obj-c but I've tried this before, the system we use to generate the docs doesn't work with that and requires objectivec, there's an example in messaging/usage.md which I always have to look at from my previous work to remember which to use, and objectivec is it

@mikehardy mikehardy merged commit de2503b into main Mar 24, 2025
10 checks passed
@mikehardy mikehardy deleted the @mikehardy/install-docs-update branch March 24, 2025 14:55
@mikehardy mikehardy removed the Workflow: Needs Review Pending feedback or review from a maintainer. label Mar 24, 2025
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.

4 participants