Skip to content

Commit 983e69c

Browse files
docs: Move documentations to separate folders (#8320)
## Summary To keep everything well structured we decided to move docs to its separate folder `docs`. Now it's the structure: ``` ├── apps │ ├── common-app // shared source code of example apps │ ├── fabric-example // React Native app wrapper running the New Architecture for shared examples │ ├── macos-example // React Native for MacOS app wrapper for shared example code │ ├── next-example // Next.js wrapper for shared example code │ ├── tvos-example // React Native for TVOS app wrapper for shared examples │ └── web-example // React Native for Web app wrapper for shared examples ├── packages │ ├── eslint-plugin-reanimated // source of eslint plugin │ ├── react-native-worklets // source of worklets package │ └── react-native-reanimated │ ├── android // source code of Android native implementation │ ├── apple // source code of iOS native implementation │ ├── Common // shared C++ code │ ├── scripts // JavaScript and bash scripts used in the CI pipeline │ ├── src // reanimated source code │ └── plugin // source code of the babel plugin └── docs ├── docs-reanimated // documentation described further in Helping with documentation └── docs-worklets // documentation for Worklets ``` ## Test plan
1 parent 6942242 commit 983e69c

File tree

940 files changed

+61
-81
lines changed

Some content is hidden

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

940 files changed

+61
-81
lines changed

.github/labeler.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
'lib: Reanimated':
22
- changed-files:
33
- any-glob-to-any-file:
4-
['packages/react-native-reanimated/**', 'packages/docs-reanimated/**']
4+
['packages/react-native-reanimated/**', 'docs/docs-reanimated/**']
55

66
'lib: Worklets':
77
- changed-files:
88
- any-glob-to-any-file:
9-
['packages/react-native-worklets/**', 'packages/docs-worklets/**']
9+
['packages/react-native-worklets/**', 'docs/docs-worklets/**']

.github/workflows/docs-reanimated-build-check.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ on:
55
pull_request:
66
paths:
77
- '.github/workflows/docs-reanimated-build-check.yml'
8-
- packages/docs-reanimated/**
8+
- docs/docs-reanimated/**
99
- packages/react-native-reanimated/compatibility.json
1010
merge_group:
1111
branches:
@@ -18,8 +18,8 @@ jobs:
1818
if: github.repository == 'software-mansion/react-native-reanimated'
1919
runs-on: ubuntu-latest
2020
env:
21-
REANIMATED_DOCS_DIR: packages/docs-reanimated
22-
WORKLETS_DOCS_DIR: packages/docs-worklets
21+
REANIMATED_DOCS_DIR: docs/docs-reanimated
22+
WORKLETS_DOCS_DIR: docs/docs-worklets
2323
steps:
2424
- name: Check out
2525
uses: actions/checkout@v4

.github/workflows/docs-reanimated-publish.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ on:
66
branches:
77
- main
88
paths:
9-
- packages/docs-reanimated/**
10-
- packages/docs-worklets/**
9+
- docs/docs-reanimated/**
10+
- docs/docs-worklets/**
1111
- packages/react-native-reanimated/compatibility.json
1212
workflow_dispatch:
1313

@@ -16,8 +16,8 @@ jobs:
1616
if: github.repository == 'software-mansion/react-native-reanimated'
1717
runs-on: ubuntu-latest
1818
env:
19-
REANIMATED_DOCS_DIR: packages/docs-reanimated
20-
WORKLETS_DOCS_DIR: packages/docs-worklets
19+
REANIMATED_DOCS_DIR: docs/docs-reanimated
20+
WORKLETS_DOCS_DIR: docs/docs-worklets
2121
steps:
2222
- name: Check out
2323
uses: actions/checkout@v4
@@ -41,6 +41,6 @@ jobs:
4141
- name: Publish generated content to GitHub Pages
4242
uses: JamesIves/github-pages-deploy-action@releases/v3
4343
with:
44-
FOLDER: packages/docs-reanimated/build
44+
FOLDER: docs/docs-reanimated/build
4545
BRANCH: gh-pages
4646
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.husky/pre-commit

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ fi
6161

6262
# Linting docs
6363
for DOCS in docs-reanimated docs-worklets; do
64-
DOCS_PATH="packages/$DOCS"
64+
DOCS_PATH="docs/$DOCS"
6565
check_and_lint_docs "$STAGED_FILES" "$DOCS_PATH" "$DOCS"
6666
done
6767

.prettiereslintignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
# This file is needed to make `yarn prettier .` and `yarn eslint`
1+
# This file is needed to make `yarn prettier .` and `yarn eslint`
22
# called in root not try to format everything in the monorepo.
33

44
packages/
55
apps/
6+
docs/
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)