Skip to content

Commit b2ea78b

Browse files
KrzysztofMochKrzysztofMoch
committed
docs: sync with branches changes
1 parent 605feed commit b2ea78b

File tree

7 files changed

+59
-63
lines changed

7 files changed

+59
-63
lines changed

‎.github/workflows/deploy-docs.yml‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,14 @@ on:
44
workflow_dispatch:
55
push:
66
branches:
7-
- v7
7+
- master
88
paths:
99
# Update on workflow change
10-
- '.github/workflows/deploy-docs.yml'
10+
- ".github/workflows/deploy-docs.yml"
1111
# Update on docs change
12-
- 'docs/**'
12+
- "docs/**"
1313
# Update on code change (Api Reference)
14-
- 'packages/react-native-video/src/**'
15-
14+
- "packages/react-native-video/src/**"
1615

1716
jobs:
1817
build:
@@ -49,4 +48,4 @@ jobs:
4948
steps:
5049
- name: Deploy to GitHub Pages
5150
id: deployment
52-
uses: actions/deploy-pages@v4
51+
uses: actions/deploy-pages@v4

‎.github/workflows/test-docs-build.yml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ name: Test Documentation Build
33
on:
44
pull_request:
55
branches:
6-
- v7
6+
- master
77
paths:
88
# Update on workflow change
9-
- '.github/workflows/test-docs-build.yml'
9+
- ".github/workflows/test-docs-build.yml"
1010
# Update on docs change
11-
- 'docs/**'
11+
- "docs/**"
1212
# Update on code change (Api Reference)
13-
- 'packages/react-native-video/src/**'
13+
- "packages/react-native-video/src/**"
1414

1515
jobs:
1616
test-docs-deploy:
@@ -24,4 +24,4 @@ jobs:
2424
- uses: ./.github/actions/setup-bun
2525

2626
- name: Test build website
27-
run: bun run --cwd docs build
27+
run: bun run --cwd docs build

‎README.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,9 @@ The most battle-tested open-source video player component for React Native with
4141

4242
## 📚 Documentation & Examples
4343

44-
- 📖 [Documentation](https://docs.thewidlarzgroup.com/react-native-video)
44+
- 📖 [Documentation](https://docs.thewidlarzgroup.com/react-native-video/docs/v7/intro)
4545
- 📦 [Example: Basic Usage](https://github.com/TheWidlarzGroup/react-native-video/tree/v7/example)
4646
- 📦 [Example: Free DRM Stream](https://www.thewidlarzgroup.com/services/free-drm-token-generator-for-video?utm_source=rnv&utm_medium=readme&utm_id=free-drm)
47-
- 📦 Example: Offline SDK integration - In Progress 🏗️, will be available soon
4847

4948
## 🚀 Quick Start
5049

‎bun.lock‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
{
22
"lockfileVersion": 1,
3-
"configVersion": 0,
43
"workspaces": {
54
"": {
65
"name": "react-native-video-monorepo",
@@ -52,7 +51,7 @@
5251
},
5352
"example": {
5453
"name": "react-native-video-example",
55-
"version": "7.0.0-beta.1",
54+
"version": "7.0.0-beta.2",
5655
"dependencies": {
5756
"@react-native-community/slider": "^4.5.6",
5857
"@react-native-video/drm": "*",
@@ -80,7 +79,7 @@
8079
},
8180
"packages/drm-plugin": {
8281
"name": "@react-native-video/drm",
83-
"version": "7.0.0-beta.1",
82+
"version": "7.0.0-beta.2",
8483
"devDependencies": {
8584
"@react-native/babel-preset": "0.79.2",
8685
"@release-it/conventional-changelog": "^9.0.2",
@@ -108,7 +107,7 @@
108107
},
109108
"packages/react-native-video": {
110109
"name": "react-native-video",
111-
"version": "7.0.0-beta.1",
110+
"version": "7.0.0-beta.2",
112111
"devDependencies": {
113112
"@expo/config-plugins": "^10.0.2",
114113
"@react-native/eslint-config": "^0.77.0",

‎docs/README.md‎

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,19 @@
1-
### Build
1+
### Instalation
2+
3+
To install the dependencies, run at the root of the repository:
24

35
```
4-
$ bun run build
6+
$ bun install
57
```
68

7-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
8-
9-
### Deployment
9+
### Development
1010

11-
Using SSH:
11+
To start a local development server with hot-reloading, run:
1212

1313
```
14-
$ USE_SSH=true bun run deploy
14+
$ bun run start
1515
```
1616

17-
Not using SSH:
18-
19-
```
20-
$ GIT_USER=<Your GitHub username> bun run deploy
21-
```
17+
### Deployment
2218

23-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
19+
Deployment is handled via GitHub Actions. Upon pushing to the `master` branch content from the `docs` directory is automatically deployed to GitHub Pages.

‎docs/sidebars.ts‎

Lines changed: 34 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,61 @@
1-
import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
1+
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
22

33
const sidebars: SidebarsConfig = {
44
docsSidebar: [
55
{
6-
type: 'autogenerated',
7-
dirName: '.',
6+
type: "autogenerated",
7+
dirName: ".",
88
},
99
{
10-
type: 'html',
11-
value: '<hr style="margin: 1rem 0; border: none; border-top: 1px solid var(--ifm-color-emphasis-300);" />',
10+
type: "html",
11+
value:
12+
'<hr style="margin: 1rem 0; border: none; border-top: 1px solid var(--ifm-color-emphasis-300);" />',
1213
},
1314
{
14-
type: 'link',
15-
label: 'Example Apps',
16-
href: 'https://github.com/TheWidlarzGroup/react-native-video/tree/master/examples',
15+
type: "link",
16+
label: "Example Apps",
17+
href: "https://github.com/TheWidlarzGroup/react-native-video/tree/master/example",
1718
},
1819
{
19-
type: 'doc',
20-
label: 'Useful Projects',
21-
id: 'projects',
20+
type: "doc",
21+
label: "Useful Projects",
22+
id: "projects",
2223
},
2324
{
24-
type: 'html',
25-
value: '<hr style="margin: 1rem 0; border: none; border-top: 1px solid var(--ifm-color-emphasis-300);" />',
25+
type: "html",
26+
value:
27+
'<hr style="margin: 1rem 0; border: none; border-top: 1px solid var(--ifm-color-emphasis-300);" />',
2628
},
2729
{
28-
type: 'link',
29-
label: 'Offline Video SDK',
30-
href: 'https://www.thewidlarzgroup.com/offline-video-sdk/?utm_source=rnv&utm_medium=docs&utm_campaign=sidebar&utm_id=offline-video-sdk-button',
30+
type: "link",
31+
label: "Offline Video SDK",
32+
href: "https://www.thewidlarzgroup.com/offline-video-sdk/?utm_source=rnv&utm_medium=docs&utm_campaign=sidebar&utm_id=offline-video-sdk-button",
3133
},
3234
{
33-
type: 'link',
34-
label: 'Enterprise Support',
35-
href: 'https://www.thewidlarzgroup.com/?utm_source=rnv&utm_medium=docs&utm_campaign=navbar&utm_id=enterprise#Contact',
35+
type: "link",
36+
label: "Enterprise Support",
37+
href: "https://www.thewidlarzgroup.com/?utm_source=rnv&utm_medium=docs&utm_campaign=navbar&utm_id=enterprise#Contact",
3638
},
3739
{
38-
type: 'link',
39-
label: 'Boost Your Issue',
40-
href: 'https://www.thewidlarzgroup.com/issue-boost/?utm_source=rnv&utm_medium=docs&utm_campaign=sidebar&utm_id=issue-boost-button',
40+
type: "link",
41+
label: "Boost Your Issue",
42+
href: "https://www.thewidlarzgroup.com/issue-boost/?utm_source=rnv&utm_medium=docs&utm_campaign=sidebar&utm_id=issue-boost-button",
4143
},
4244
{
43-
type: 'html',
44-
value: '<hr style="margin: 1rem 0; border: none; border-top: 1px solid var(--ifm-color-emphasis-300);" />',
45+
type: "html",
46+
value:
47+
'<hr style="margin: 1rem 0; border: none; border-top: 1px solid var(--ifm-color-emphasis-300);" />',
4548
},
4649
{
47-
type: 'doc',
48-
label: 'Updating',
49-
id: 'updating',
50+
type: "doc",
51+
label: "Updating",
52+
id: "updating",
5053
},
5154
{
52-
type: 'link',
53-
label: 'Releases',
54-
href: 'https://github.com/TheWidlarzGroup/react-native-video/releases',
55-
}
55+
type: "link",
56+
label: "Releases",
57+
href: "https://github.com/TheWidlarzGroup/react-native-video/releases",
58+
},
5659
],
5760
};
5861

‎docs/versioned_sidebars/version-6.x-sidebars.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
{
1212
"type": "link",
1313
"label": "Example Apps",
14-
"href": "https://github.com/TheWidlarzGroup/react-native-video/tree/master/examples"
14+
"href": "https://github.com/TheWidlarzGroup/react-native-video/tree/support/6.x.x/examples"
1515
},
1616
{
1717
"type": "doc",
@@ -49,7 +49,7 @@
4949
{
5050
"type": "link",
5151
"label": "Changelog",
52-
"href": "https://github.com/TheWidlarzGroup/react-native-video/blob/master/CHANGELOG.md"
52+
"href": "https://github.com/TheWidlarzGroup/react-native-video/blob/support/6.x.x/CHANGELOG.md"
5353
}
5454
]
5555
}

0 commit comments

Comments
 (0)