Skip to content

Commit 7e270cb

Browse files
[codex] Refocus docs on binding-specific guidance (#187)
* Refocus docs on binding-specific guidance * Restore binding-specific docs notes * Preserve native-to-managed setup notes * Document Crashlytics binding configuration * Clarify Crashlytics symbol upload properties
1 parent d14c4fa commit 7e270cb

51 files changed

Lines changed: 824 additions & 11016 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Readme.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ Nullability updates are generally compile-time metadata changes, but they can su
104104

105105
## Quick links
106106

107+
- Documentation index: [docs/README.md](docs/README.md)
107108
- Build locally: [docs/BUILDING.md](docs/BUILDING.md)
108109
- Publish to GitHub Packages: [docs/PUBLISHING_GITHUB_PACKAGES.md](docs/PUBLISHING_GITHUB_PACKAGES.md)
109110
- Contributing guidelines: [CONTRIBUTING.md](CONTRIBUTING.md)

docs/BUILDING.md

Lines changed: 26 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,47 @@
1-
# Building locally (macOS)
1+
# Building Locally
22

3-
This repo builds .NET iOS/macOS bindings and NuGet packages using Cake.
3+
This repository builds .NET iOS and Mac Catalyst bindings plus NuGet packages using Cake.
44

55
## Prerequisites
66

7-
- .NET SDK (see `global.json`)
8-
- Xcode (matching the installed iOS workload requirements)
9-
- CocoaPods (`pod`)
7+
- .NET SDK from `global.json`.
8+
- Xcode compatible with the installed .NET Apple workloads.
9+
- CocoaPods (`pod`).
1010

11-
Restore the local Cake tool from the checked-in .NET tool manifest:
11+
Restore the checked-in Cake tool manifest before building:
1212

1313
```sh
1414
dotnet tool restore
1515
```
1616

17-
## Configure GitHub Packages feed (for fork contributors)
17+
## GitHub Packages Feed for Forks
1818

19-
If you are working on a fork of this repository and want to resolve NuGet packages published from your fork, run:
19+
If you are working from a fork and need to restore packages published from that fork, configure a GitHub Packages source:
2020

2121
```sh
22-
# Using GitHub CLI (recommended)
2322
./scripts/configure-github-feed.sh --gh
23+
```
24+
25+
You can also use a local personal access token with `read:packages` scope:
2426

25-
# Or using a personal access token
27+
```sh
2628
export GITHUB_PACKAGES_PAT="your_github_pat_here"
2729
./scripts/configure-github-feed.sh
2830
```
2931

30-
This script:
31-
- Auto-detects your fork owner from the git remote URL
32-
- Configures a GitHub Packages feed (`github-<YourUsername>`)
33-
- Allows `dotnet restore` to resolve packages published from your fork
32+
Do not commit tokens or generated local NuGet credentials.
3433

35-
**Note**: Your GitHub Personal Access Token must have the `read:packages` scope. See [GitHub docs](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic) for token creation.
34+
The script detects the fork owner from the git remote, adds a source named like `github-<YourUsername>`, and allows `dotnet restore` to resolve fork-published packages.
3635

37-
## Build + pack a component
36+
## Build and Pack One Component
3837

39-
Build and produce `.nupkg` files into `./output`:
38+
Build and produce `.nupkg` files under `./output`:
4039

4140
```sh
4241
dotnet tool run dotnet-cake -- --target=nuget --names=Google.SignIn
4342
```
4443

45-
## Clean-up
46-
47-
To clean generated folders:
44+
## Clean Generated Output
4845

4946
```sh
5047
dotnet tool run dotnet-cake -- --target=clean
@@ -54,34 +51,30 @@ dotnet tool run dotnet-cake -- --target=clean
5451

5552
### MSB4057: The target "source/..." does not exist
5653

57-
This error can occur when using MSBuild solution-level targets with certain .NET SDK versions. The `build.cake` script avoids this by building each `.csproj` directly in dependency order, which is more explicit and reliable.
54+
This can happen when using MSBuild solution-level targets with some .NET SDK versions. The Cake script builds `.csproj` files directly in dependency order to avoid that failure mode.
5855

5956
### NU1101: Unable to find package AdamE.Google.iOS.AppCheckCore
6057

61-
Some packages (like `SignIn`) depend on `AppCheckCore` which is built from this repo. The Cake script handles this automatically by building dependencies first. If you still encounter this:
58+
Some packages depend on other packages built from this repository. The Cake script handles dependency-first packing. If restore still fails, run the component build through Cake instead of building the project directly:
6259

63-
1. Ensure you're using the latest `build.cake` (it should iterate `ARTIFACTS_TO_BUILD`)
64-
2. Run the full build: `dotnet tool run dotnet-cake -- --target=nuget --names=Google.SignIn`
60+
```sh
61+
dotnet tool run dotnet-cake -- --target=nuget --names=Google.SignIn
62+
```
6563

6664
### Code signing errors during xcframework build
6765

68-
The Cake scripts disable code signing by default (`CODE_SIGNING_ALLOWED=NO`) for CI compatibility. If you need signed frameworks, override the build settings in `common.cake`.
66+
The Cake scripts disable code signing by default (`CODE_SIGNING_ALLOWED=NO`) for CI compatibility. If you need signed frameworks, override the build settings locally instead of committing signing material.
6967

7068
### NuGet feed issues
7169

72-
If you see errors like:
73-
```
74-
NU1101: Unable to find package AdamE.Firebase.iOS.AppCheck [...]
75-
```
70+
If restore cannot find packages from a fork, verify the configured sources:
7671

77-
This may occur if your GitHub Packages feed is not configured. See "[Configure GitHub Packages feed](#configure-github-packages-feed-for-fork-contributors)" above.
78-
79-
Verify your feed configuration:
8072
```sh
8173
dotnet nuget list source
8274
```
8375

84-
Clear the NuGet cache if needed:
76+
Then clear local NuGet caches if needed:
77+
8578
```sh
8679
dotnet nuget locals all --clear
8780
dotnet restore

docs/Firebase/Analytics/Details.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
1-
Firebase Analytics is a free app measurement solution that provides insight on app usage and user engagement.
1+
# Firebase Analytics
22

3-
At the heart of Firebase is Firebase Analytics, a free and unlimited analytics solution. Analytics integrates across Firebase features and provides you with unlimited reporting for up to 500 distinct events that you can define using the Firebase SDK. Analytics reports help you understand clearly how your users behave, which enables you to make informed decisions regarding app marketing and performance optimizations.
3+
This path is retained for existing links, but this repository does not maintain a copied Firebase Analytics walkthrough.
44

5-
## Key capabilities
5+
These packages are thin .NET bindings over the native Firebase Apple SDKs. Use the official native documentation as the source of truth for setup, product behavior, console workflows, quotas, policy requirements, and examples.
66

7-
| | |
8-
|-:|-|
9-
| **Unlimited Reporting:** | Firebase Analytics provides unlimited reporting on up to 500 distinct events. |
10-
| **Audience Segmentation:** | Custom audiences can be defined in the Firebase console based on device data, custom events, or user properties. These audiences can be used with other Firebase features when targeting new features or notifications messages. |
7+
## Native Documentation
118

12-
## How does it work?
9+
- Firebase Apple setup: https://firebase.google.com/docs/ios/setup
10+
- Firebase Analytics documentation: https://firebase.google.com/docs/analytics/get-started
1311

14-
Firebase Analytics helps you understand how people use your iOS app. The SDK automatically captures a number of events and user properties and also allows you to define your own custom events to measure the things that uniquely matter to your business. Once the data is captured, it's available in a dashboard through the Firebase console. This dashboard provides detailed insights about your data — from summary data such as active users and demographics, to more detailed data such as identifying your most purchased items.
12+
## Binding Package
1513

16-
Analytics also integrates with a number of other Firebase features. For example, it automatically logs events that correspond to notification messages sent via the Notifications composer and provides reporting on the impact of each campaign.
14+
- Package README: [../NuGet/Analytics.md](../NuGet/Analytics.md)
15+
- Package ID: `AdamE.Firebase.iOS.Analytics`
16+
- Managed namespace: `Firebase.Analytics`
1717

18-
Firebase Analytics helps you understand how your users behave, so you can make informed decisions about how to market your app. See the performance of your campaigns across organic and paid channels to understand which methods are most effective at driving high-value users. If you need to perform custom analysis or join your data with other sources you can link your Analytics data to BigQuery, which allows for more complex analysis like querying large data sets and joining multiple data sources.
19-
20-
<sub>_Portions of this page are modifications based on work created and [shared by Google](https://developers.google.com/readme/policies/) and used according to terms described in the [Creative Commons 3.0 Attribution License](http://creativecommons.org/licenses/by/3.0/). Click [here](https://firebase.google.com/docs/analytics/) to see original Firebase documentation._</sub>
18+
Document only binding-specific caveats in this repository. Product usage guidance belongs in the official native docs.

0 commit comments

Comments
 (0)