Skip to content

Commit bbf4f43

Browse files
abueideclaude
andauthored
docs: centralize and update wiki documentation (#1279)
* docs: centralize documentation into wiki/ Move scattered docs into wiki/ for a single documentation hub: - MIGRATION_GUIDE.md -> wiki/migration-v2.md - examples/README.md -> wiki/e2e-overview.md - examples/SHARED_E2E_SETUP.md -> wiki/e2e-setup.md - examples/CHANGELOG.md -> wiki/e2e-changelog.md (new) - examples/NEW_ARCH_MIGRATION.md -> wiki/new-arch-migration.md (new) - Add wiki/README.md index Keep project READMEs (e2e-compat, e2e-latest, e2e-shared) in place since they're meant to be copied with the example apps. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: remove outdated wiki pages and fix broken links Delete wiki/nix.md and wiki/scripts.md which documented removed infrastructure (nix flake, scripts/ directory, shells/ configs). Rewrite wiki/devbox.md to reflect the current per-app devbox setup with the mobile-devtools plugin. Fix root README link to migration guide (moved to wiki/) and add wiki pointer in Contributing section. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: fix table of contents links in root README Flatten the ToC to top-level section links only. The previous deeply nested structure with a self-referential parent item wasn't rendering as clickable links on GitHub. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: organize wiki into subfolders Move E2E docs into wiki/e2e/ and migration guides into wiki/guides/ for better discoverability. Update all links in wiki/README.md and root README.md. wiki/ ├── README.md ├── devbox.md ├── release.md ├── e2e/ │ ├── overview.md │ ├── setup.md │ └── changelog.md └── guides/ ├── migration-v2.md └── new-arch-migration.md Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent d1f984a commit bbf4f43

15 files changed

Lines changed: 646 additions & 560 deletions

File tree

README.md

Lines changed: 13 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -10,52 +10,17 @@ The hassle-free way to add Segment analytics to your React-Native app.
1010

1111
## Table of Contents
1212

13-
- [@segment/analytics-react-native](#segmentanalytics-react-native)
14-
- [Table of Contents](#table-of-contents)
15-
- [Installation](#installation)
16-
- [Expo](#expo)
17-
- [Permissions](#permissions)
18-
- [Migrating](#migrating)
19-
- [Usage](#usage)
20-
- [Setting up the client](#setting-up-the-client)
21-
- [Client Options](#client-options)
22-
- [iOS Deep Link Tracking Setup](#ios-deep-link-tracking-setup)
23-
- [Native AnonymousId](#native-anonymousid)
24-
- [Usage with hooks](#usage-with-hooks)
25-
- [useAnalytics()](#useanalytics)
26-
- [Usage without hooks](#usage-without-hooks)
27-
- [Client methods](#client-methods)
28-
- [Track](#track)
29-
- [Screen](#screen)
30-
- [Identify](#identify)
31-
- [Group](#group)
32-
- [Alias](#alias)
33-
- [Reset](#reset)
34-
- [Flush](#flush)
35-
- [(Advanced) Cleanup](#advanced-cleanup)
36-
- [Automatic screen tracking](#automatic-screen-tracking)
37-
- [React Navigation](#react-navigation)
38-
- [React Native Navigation](#react-native-navigation)
39-
- [Consent Management](#consent-management)
40-
- [Segment CMP](#segment-managed-cmp)
41-
- [Event Stamping](#event-stamping)
42-
- [Segment Consent Preference Updated Event](#segment-consent-preference-updated-event)
43-
- [Event Flow](#event-flow)
44-
- [Getting Started](#getting-started)
45-
- [Plugins + Timeline architecture](#plugins--timeline-architecture)
46-
- [Plugin Types](#plugin-types)
47-
- [Destination Plugins](#destination-plugins)
48-
- [Adding Plugins](#adding-plugins)
49-
- [Writing your own Plugins](#writing-your-own-plugins)
50-
- [Supported Plugins](#supported-plugins)
51-
- [Controlling Upload With Flush Policies](#controlling-upload-with-flush-policies)
52-
- [Adding or removing policies](#adding-or-removing-policies)
53-
- [Creating your own flush policies](#creating-your-own-flush-policies)
54-
- [Handling errors](#handling-errors)
55-
- [Reporting errors from plugins](#reporting-errors-from-plugins)
56-
- [Contributing](#contributing)
57-
- [Code of Conduct](#code-of-conduct)
58-
- [License](#license)
13+
- [Installation](#installation)
14+
- [Migrating](#migrating)
15+
- [Usage](#usage)
16+
- [Client methods](#client-methods)
17+
- [Automatic screen tracking](#automatic-screen-tracking)
18+
- [Consent Management](#consent-management)
19+
- [Plugins + Timeline architecture](#plugins--timeline-architecture)
20+
- [Controlling Upload With Flush Policies](#controlling-upload-with-flush-policies)
21+
- [Handling errors](#handling-errors)
22+
- [Contributing](#contributing)
23+
- [License](#license)
5924

6025
## Installation
6126

@@ -98,7 +63,7 @@ In your app's `AndroidManifest.xml` add the below line between the `<manifest>`
9863

9964
## Migrating
10065

101-
See the [Migration Guide](MIGRATION_GUIDE.md) for a detailed walkthrough of the changes you will need to make when upgrading to `analytics-react-native 2.0`
66+
See the [Migration Guide](wiki/guides/migration-v2.md) for a detailed walkthrough of the changes you will need to make when upgrading to `analytics-react-native 2.0`
10267

10368
## Usage
10469

@@ -929,7 +894,7 @@ try {
929894
930895
## Contributing
931896
932-
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
897+
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow. Internal documentation for development environment setup, E2E testing, and releases is in the [wiki](wiki/README.md).
933898
934899
## Code of Conduct
935900

examples/README.md

Lines changed: 0 additions & 140 deletions
This file was deleted.

examples/SHARED_E2E_SETUP.md

Lines changed: 0 additions & 57 deletions
This file was deleted.

0 commit comments

Comments
 (0)