Skip to content

Commit bc2a8f0

Browse files
docs: upgrade documentation (#4622)
1 parent 7b8d0b8 commit bc2a8f0

File tree

90 files changed

+5434
-3962
lines changed

Some content is hidden

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

90 files changed

+5434
-3962
lines changed

.github/actions/setup-bun/action.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: setup bun
2+
description: Setup bun and install dependencies
3+
4+
inputs:
5+
working-directory:
6+
description: 'working directory for bun install'
7+
default: ./
8+
required: false
9+
10+
runs:
11+
using: composite
12+
steps:
13+
- name: Setup Bun
14+
uses: oven-sh/setup-bun@v2
15+
with:
16+
bun-version: 1.2.19
17+
18+
- name: Cache dependencies
19+
id: bun-cache
20+
uses: actions/cache@v4
21+
with:
22+
path: |
23+
**/node_modules
24+
key: ${{ runner.os }}-v7-bun-${{ hashFiles('**/bun.lock') }}-${{ hashFiles('**/package.json') }}
25+
restore-keys: |
26+
${{ runner.os }}-v7-bun-${{ hashFiles('**/bun.lock') }}
27+
${{ runner.os }}-v7-bun-
28+
29+
- name: Install dependencies
30+
working-directory: ${{ inputs.working-directory }}
31+
run: bun install
32+
shell: bash
33+

.github/actions/setup/action.yml

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

.github/workflows/ci.yml

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

.github/workflows/deploy-docs.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- v7
7+
8+
jobs:
9+
build:
10+
name: Build Documentation
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
with:
15+
fetch-depth: 0
16+
17+
- uses: ./.github/actions/setup-bun
18+
19+
- name: Build Documentation
20+
run: bun run --cwd docs build
21+
22+
- name: Upload Build Artifact
23+
uses: actions/upload-pages-artifact@v3
24+
with:
25+
path: docs/build
26+
27+
deploy:
28+
name: Deploy Documentation to GitHub Pages
29+
needs: build
30+
31+
permissions:
32+
pages: write
33+
id-token: write
34+
35+
environment:
36+
name: github-pages
37+
url: ${{ steps.deployment.outputs.page_url }}
38+
39+
runs-on: ubuntu-latest
40+
steps:
41+
- name: Deploy to GitHub Pages
42+
id: deployment
43+
uses: actions/deploy-pages@v4

.github/workflows/publish-release.yml

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

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Test Documentation Build
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- v7
7+
8+
jobs:
9+
test-docs-deploy:
10+
name: Test Documentation Build
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
with:
15+
fetch-depth: 0
16+
17+
- uses: ./.github/actions/setup-bun
18+
19+
- name: Test build website
20+
run: bun run --cwd docs build

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ The most battle-tested open-source video player component for React Native with
55
> [!IMPORTANT]
66
> This is a new version (v7) of `react-native-video` that is currently in active development.
77
> You can expect breaking changes and missing features.
8-
> We are working on the documentation and examples
98
>
109
> If you have any questions, please contact us at [[email protected]](mailto:[email protected]).
1110
@@ -42,10 +41,10 @@ The most battle-tested open-source video player component for React Native with
4241

4342
## 📚 Documentation & Examples
4443

45-
- 📖 Documentation - In progress 🏗️, will be available soon
46-
- 📦 [Example: Basic Usage](https://github.com/TheWidlarzGroup/react-native-video/tree/master/example)
44+
- 📖 [Documentation](https://docs.thewidlarzgroup.com/react-native-video)
45+
- 📦 [Example: Basic Usage](https://github.com/TheWidlarzGroup/react-native-video/tree/v7/example)
4746
- 📦 [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)
48-
- 📦 [Example: Offline SDK integration](https://docs.thewidlarzgroup.com/offline-video-sdk)
47+
- 📦 Example: Offline SDK integration - In Progress 🏗️, will be available soon
4948

5049
## 🚀 Quick Start
5150

0 commit comments

Comments
 (0)