chore: rename react-native docs dir (#417)

invertase · May 30, 2022 · 4103b37 · 4103b37
1 parent 85eb763
commit 4103b37
Show file tree

Hide file tree

Showing 53 changed files with 15 additions and 15 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1,4 +1,4 @@
 *.xcodeproj binary
 *.xcworkspace binary
-docs/typedoc.json merge=theirs linguist-vendored
-docs/typedoc.min.json merge=theirs linguist-vendored
+docs-react-native/typedoc.json merge=theirs linguist-vendored
+docs-react-native/typedoc.min.json merge=theirs linguist-vendored
diff --git a/.github/workflows/docs_deployment.yml b/.github/workflows/docs_deployment.yml
@@ -4,7 +4,7 @@ on:
     branches:
       - main
     paths:
-      - 'docs/**'
+      - 'docs-react-native/**'
 
 jobs:
   build:

diff --git a/.github/workflows/tests_e2e_android.yml b/.github/workflows/tests_e2e_android.yml
@@ -4,13 +4,13 @@ on:
   workflow_dispatch:
   pull_request:
     paths-ignore:
-      - 'docs/**'
+      - 'docs-react-native/**'
       - '**/*.md'
   push:
     branches:
       - main
     paths-ignore:
-      - 'docs/**'
+      - 'docs-react-native/**'
       - '**/*.md'
 
 jobs:

diff --git a/.github/workflows/tests_e2e_ios.yml b/.github/workflows/tests_e2e_ios.yml
@@ -4,13 +4,13 @@ on:
   workflow_dispatch:
   pull_request:
     paths-ignore:
-      - 'docs/**'
+      - 'docs-react-native/**'
       - '**/*.md'
   push:
     branches:
       - main
     paths-ignore:
-      - 'docs/**'
+      - 'docs-react-native/**'
       - '**/*.md'
 
 jobs:

diff --git a/.github/workflows/tests_jest.yml b/.github/workflows/tests_jest.yml
@@ -4,13 +4,13 @@ on:
   workflow_dispatch:
   pull_request:
     paths-ignore:
-      - 'docs/**'
+      - 'docs-react-native/**'
       - '**/*.md'
   push:
     branches:
       - main
     paths-ignore:
-      - 'docs/**'
+      - 'docs-react-native/**'
       - '**/*.md'
 
 jobs:

diff --git a/.github/workflows/tests_junit.yml b/.github/workflows/tests_junit.yml
@@ -10,7 +10,7 @@ on:
     branches:
       - main
     paths-ignore:
-      - 'docs/**'
+      - 'docs-react-native/**'
       - '**/*.md'
 
 jobs:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -83,7 +83,7 @@ Maintainers with write access to the repo and the npm organization can publish n
 ### Release Checklist
 
 1. Navigate to the React Native package: `cd packages/react-native`
-1. Update release notes [here](https://github.com/invertase/notifee/blob/main/docs/react-native/docs/release-notes.md)
+1. Update release notes [here](https://github.com/invertase/notifee/blob/main/docs-react-native/react-native/docs/release-notes.md)
 1. Bump version: `npm version {minor/patch}`
 1. Tag the repo (current format is `@notifee/[email protected]`)
 1. Push the release notes / version / tag to the repo: `git push --tags`

diff --git a/docs/docs.md → docs-react-native/docs.md b/docs/docs.md → docs-react-native/docs.md
diff --git a/docs/navigator.json → docs-react-native/navigator.json b/docs/navigator.json → docs-react-native/navigator.json
diff --git a/docs/react-native/docs/android/appearance.md → ...e/react-native/docs/android/appearance.md b/docs/react-native/docs/android/appearance.md → ...e/react-native/docs/android/appearance.md
diff --git a/...e/docs/android/background-restrictions.md → ...e/docs/android/background-restrictions.md b/...e/docs/android/background-restrictions.md → ...e/docs/android/background-restrictions.md
diff --git a/docs/react-native/docs/android/behaviour.md → ...ve/react-native/docs/android/behaviour.md b/docs/react-native/docs/android/behaviour.md → ...ve/react-native/docs/android/behaviour.md
diff --git a/docs/react-native/docs/android/bubbles.md → ...tive/react-native/docs/android/bubbles.md b/docs/react-native/docs/android/bubbles.md → ...tive/react-native/docs/android/bubbles.md
diff --git a/docs/react-native/docs/android/channels.md → ...ive/react-native/docs/android/channels.md b/docs/react-native/docs/android/channels.md → ...ive/react-native/docs/android/channels.md
diff --git a/...native/docs/android/foreground-service.md → ...native/docs/android/foreground-service.md b/...native/docs/android/foreground-service.md → ...native/docs/android/foreground-service.md
diff --git a/...tive/docs/android/grouping-and-sorting.md → ...tive/docs/android/grouping-and-sorting.md b/...tive/docs/android/grouping-and-sorting.md → ...tive/docs/android/grouping-and-sorting.md
diff --git a/docs/react-native/docs/android/index.md → ...native/react-native/docs/android/index.md b/docs/react-native/docs/android/index.md → ...native/react-native/docs/android/index.md
diff --git a/.../react-native/docs/android/interaction.md → .../react-native/docs/android/interaction.md b/.../react-native/docs/android/interaction.md → .../react-native/docs/android/interaction.md
diff --git a/...react-native/docs/android/introduction.md → ...react-native/docs/android/introduction.md b/...react-native/docs/android/introduction.md → ...react-native/docs/android/introduction.md
diff --git a/.../react-native/docs/android/permissions.md → .../react-native/docs/android/permissions.md b/.../react-native/docs/android/permissions.md → .../react-native/docs/android/permissions.md
diff --git a/...ative/docs/android/progress-indicators.md → ...ative/docs/android/progress-indicators.md b/...ative/docs/android/progress-indicators.md → ...ative/docs/android/progress-indicators.md
diff --git a/docs/react-native/docs/android/styles.md → ...ative/react-native/docs/android/styles.md b/docs/react-native/docs/android/styles.md → ...ative/react-native/docs/android/styles.md
diff --git a/docs/react-native/docs/android/timers.md → ...ative/react-native/docs/android/timers.md b/docs/react-native/docs/android/timers.md → ...ative/react-native/docs/android/timers.md
diff --git a/docs/react-native/docs/debugging.md → ...act-native/react-native/docs/debugging.md b/docs/react-native/docs/debugging.md → ...act-native/react-native/docs/debugging.md
diff --git a/...-native/docs/displaying-a-notification.md → ...-native/docs/displaying-a-notification.md b/...-native/docs/displaying-a-notification.md → ...-native/docs/displaying-a-notification.md
diff --git a/.../react-native/docs/environment-support.md → .../react-native/docs/environment-support.md b/.../react-native/docs/environment-support.md → .../react-native/docs/environment-support.md
diff --git a/docs/react-native/docs/events.md → ...-react-native/react-native/docs/events.md b/docs/react-native/docs/events.md → ...-react-native/react-native/docs/events.md
diff --git a/docs/react-native/docs/index.md → docs-react-native/react-native/docs/index.md b/docs/react-native/docs/index.md → docs-react-native/react-native/docs/index.md
diff --git a/docs/react-native/docs/installation.md → ...-native/react-native/docs/installation.md b/docs/react-native/docs/installation.md → ...-native/react-native/docs/installation.md
diff --git a/docs/react-native/docs/integrations/fcm.md → ...ive/react-native/docs/integrations/fcm.md b/docs/react-native/docs/integrations/fcm.md → ...ive/react-native/docs/integrations/fcm.md
diff --git a/...act-native/docs/integrations/onesignal.md → ...act-native/docs/integrations/onesignal.md b/...act-native/docs/integrations/onesignal.md → ...act-native/docs/integrations/onesignal.md
diff --git a/docs/react-native/docs/ios.md → docs-react-native/react-native/docs/ios.md b/docs/react-native/docs/ios.md → docs-react-native/react-native/docs/ios.md
diff --git a/docs/react-native/docs/ios/appearance.md → ...ative/react-native/docs/ios/appearance.md b/docs/react-native/docs/ios/appearance.md → ...ative/react-native/docs/ios/appearance.md
diff --git a/docs/react-native/docs/ios/badges.md → ...ct-native/react-native/docs/ios/badges.md b/docs/react-native/docs/ios/badges.md → ...ct-native/react-native/docs/ios/badges.md
diff --git a/docs/react-native/docs/ios/behaviour.md → ...native/react-native/docs/ios/behaviour.md b/docs/react-native/docs/ios/behaviour.md → ...native/react-native/docs/ios/behaviour.md
diff --git a/docs/react-native/docs/ios/categories.md → ...ative/react-native/docs/ios/categories.md b/docs/react-native/docs/ios/categories.md → ...ative/react-native/docs/ios/categories.md
diff --git a/docs/react-native/docs/ios/index.md → ...act-native/react-native/docs/ios/index.md b/docs/react-native/docs/ios/index.md → ...act-native/react-native/docs/ios/index.md
diff --git a/docs/react-native/docs/ios/interaction.md → ...tive/react-native/docs/ios/interaction.md b/docs/react-native/docs/ios/interaction.md → ...tive/react-native/docs/ios/interaction.md
diff --git a/docs/react-native/docs/ios/introduction.md → ...ive/react-native/docs/ios/introduction.md b/docs/react-native/docs/ios/introduction.md → ...ive/react-native/docs/ios/introduction.md
diff --git a/docs/react-native/docs/ios/permissions.md → ...tive/react-native/docs/ios/permissions.md b/docs/react-native/docs/ios/permissions.md → ...tive/react-native/docs/ios/permissions.md
diff --git a/...e/docs/ios/remote-notification-support.md → ...e/docs/ios/remote-notification-support.md b/...e/docs/ios/remote-notification-support.md → ...e/docs/ios/remote-notification-support.md
diff --git a/docs/react-native/docs/overview.md → ...eact-native/react-native/docs/overview.md b/docs/react-native/docs/overview.md → ...eact-native/react-native/docs/overview.md
diff --git a/docs/react-native/docs/release-notes.md → ...native/react-native/docs/release-notes.md b/docs/react-native/docs/release-notes.md → ...native/react-native/docs/release-notes.md
diff --git a/docs/react-native/docs/triggers.md → ...eact-native/react-native/docs/triggers.md b/docs/react-native/docs/triggers.md → ...eact-native/react-native/docs/triggers.md
diff --git a/docs/react-native/docs/usage.md → docs-react-native/react-native/docs/usage.md b/docs/react-native/docs/usage.md → docs-react-native/react-native/docs/usage.md
diff --git a/docs/react-native/index.md → docs-react-native/react-native/index.md b/docs/react-native/index.md → docs-react-native/react-native/index.md
diff --git a/docs/react-native/reference.md → docs-react-native/react-native/reference.md b/docs/react-native/reference.md → docs-react-native/react-native/reference.md
diff --git a/docs/react-native/resources.md → docs-react-native/react-native/resources.md b/docs/react-native/resources.md → docs-react-native/react-native/resources.md
diff --git a/docs/typedoc.json → docs-react-native/typedoc.json b/docs/typedoc.json → docs-react-native/typedoc.json
diff --git a/docs/typedoc.min.json → docs-react-native/typedoc.min.json b/docs/typedoc.min.json → docs-react-native/typedoc.min.json
diff --git a/package.json b/package.json
@@ -27,7 +27,7 @@
     "lerna:bootstrap": "lerna bootstrap",
     "lerna:link": "lerna link && lerna exec -- yarn link",
     "lerna:clean": "lerna clean",
-    "gen:reference": "rimraf docs/typedoc.json docs/typedoc.min.json && node scripts/generate-typedoc.js",
+    "gen:reference": "rimraf docs-react-native/typedoc.json docs-react-native/typedoc.min.json && node scripts/generate-typedoc.js",
     "test:all": "yarn test:core:android && yarn tests_rn:test && yarn tests_rn:android:test && yarn tests_rn:ios:test",
     "test:core:android": "cd android && ./gradlew testDebugUnit",
     "tests_rn:packager": "cd tests_react_native && npx react-native start",

diff --git a/scripts/generate-typedoc.js b/scripts/generate-typedoc.js
@@ -19,8 +19,8 @@ const { readFileSync, writeFileSync } = require('fs');
 const path = require('path');
 const { Application, TSConfigReader } = require('typedoc');
 
-const output = path.resolve(process.cwd(), 'docs', 'typedoc.json');
-const outputMin = path.resolve(process.cwd(), 'docs', 'typedoc.min.json');
+const output = path.resolve(process.cwd(), 'docs-react-native', 'typedoc.json');
+const outputMin = path.resolve(process.cwd(), 'docs-react-native', 'typedoc.min.json');
 
 const app = new Application();
 app.options.addReader(new TSConfigReader());

diff --git a/tests_react_native/metro.config.js b/tests_react_native/metro.config.js
@@ -17,7 +17,7 @@ const config = {
     blocklist: exclusionList([
       /.*\/__fixtures__\/.*/,
       /.*\/template\/project\/node_modules\/react-native\/.*/,
-      new RegExp(`^${escape(resolve(rootDir, 'docs'))}\\/.*$`),
+      new RegExp(`^${escape(resolve(rootDir, 'docs-react-native'))}\\/.*$`),
       new RegExp(`^${escape(resolve(rootDir, 'tests_react_native/ios'))}\\/.*$`),
       new RegExp(`^${escape(resolve(rootDir, 'tests_react_native/e2e'))}\\/.*$`),
       new RegExp(`^${escape(resolve(rootDir, 'tests_react_native/android'))}\\/.*$`),
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,7 +4,7 @@ on: @@
         branches:
           - main
         paths:
-          - 'docs/**'
+          - 'docs-react-native/**'
     jobs:
       build:
@@ Expand Down @@