diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index d475a622..f5a6a16d 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -4,15 +4,14 @@ on: workflow_dispatch: push: branches: - - v7 + - master paths: # Update on workflow change - - '.github/workflows/deploy-docs.yml' + - ".github/workflows/deploy-docs.yml" # Update on docs change - - 'docs/**' + - "docs/**" # Update on code change (Api Reference) - - 'packages/react-native-video/src/**' - + - "packages/react-native-video/src/**" jobs: build: @@ -49,4 +48,4 @@ jobs: steps: - name: Deploy to GitHub Pages id: deployment - uses: actions/deploy-pages@v4 \ No newline at end of file + uses: actions/deploy-pages@v4 diff --git a/.github/workflows/test-docs-build.yml b/.github/workflows/test-docs-build.yml index e27e8d45..eb1fce59 100644 --- a/.github/workflows/test-docs-build.yml +++ b/.github/workflows/test-docs-build.yml @@ -3,14 +3,14 @@ name: Test Documentation Build on: pull_request: branches: - - v7 + - master paths: # Update on workflow change - - '.github/workflows/test-docs-build.yml' + - ".github/workflows/test-docs-build.yml" # Update on docs change - - 'docs/**' + - "docs/**" # Update on code change (Api Reference) - - 'packages/react-native-video/src/**' + - "packages/react-native-video/src/**" jobs: test-docs-deploy: @@ -24,4 +24,4 @@ jobs: - uses: ./.github/actions/setup-bun - name: Test build website - run: bun run --cwd docs build \ No newline at end of file + run: bun run --cwd docs build diff --git a/README.md b/README.md index 1430521a..a5a95882 100644 --- a/README.md +++ b/README.md @@ -41,10 +41,9 @@ The most battle-tested open-source video player component for React Native with ## 📚 Documentation & Examples -- 📖 [Documentation](https://docs.thewidlarzgroup.com/react-native-video) +- 📖 [Documentation](https://docs.thewidlarzgroup.com/react-native-video/docs/v7/intro) - 📦 [Example: Basic Usage](https://github.com/TheWidlarzGroup/react-native-video/tree/v7/example) - 📦 [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) -- 📦 Example: Offline SDK integration - In Progress 🏗️, will be available soon ## 🚀 Quick Start diff --git a/bun.lock b/bun.lock index 152b10e4..56bfe6da 100644 --- a/bun.lock +++ b/bun.lock @@ -1,6 +1,5 @@ { "lockfileVersion": 1, - "configVersion": 0, "workspaces": { "": { "name": "react-native-video-monorepo", @@ -52,7 +51,7 @@ }, "example": { "name": "react-native-video-example", - "version": "7.0.0-beta.1", + "version": "7.0.0-beta.2", "dependencies": { "@react-native-community/slider": "^4.5.6", "@react-native-video/drm": "*", @@ -80,7 +79,7 @@ }, "packages/drm-plugin": { "name": "@react-native-video/drm", - "version": "7.0.0-beta.1", + "version": "7.0.0-beta.2", "devDependencies": { "@react-native/babel-preset": "0.79.2", "@release-it/conventional-changelog": "^9.0.2", @@ -108,7 +107,7 @@ }, "packages/react-native-video": { "name": "react-native-video", - "version": "7.0.0-beta.1", + "version": "7.0.0-beta.2", "devDependencies": { "@expo/config-plugins": "^10.0.2", "@react-native/eslint-config": "^0.77.0", diff --git a/docs/README.md b/docs/README.md index 6c27da53..323f2c7c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,23 +1,19 @@ -### Build +### Instalation + +To install the dependencies, run at the root of the repository: ``` -$ bun run build +$ bun install ``` -This command generates static content into the `build` directory and can be served using any static contents hosting service. +### Development + +To start a local development server with hot-reloading, run: + +``` +$ bun run start +``` ### Deployment -Using SSH: - -``` -$ USE_SSH=true bun run deploy -``` - -Not using SSH: - -``` -$ GIT_USER= bun run deploy -``` - -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. +Deployment is handled via GitHub Actions. Upon pushing to the `master` branch content from the `docs` directory is automatically deployed to GitHub Pages. diff --git a/docs/sidebars.ts b/docs/sidebars.ts index c79be15f..99df7651 100644 --- a/docs/sidebars.ts +++ b/docs/sidebars.ts @@ -1,58 +1,61 @@ -import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'; +import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; const sidebars: SidebarsConfig = { docsSidebar: [ { - type: 'autogenerated', - dirName: '.', + type: "autogenerated", + dirName: ".", }, { - type: 'html', - value: '
', + type: "html", + value: + '
', }, { - type: 'link', - label: 'Example Apps', - href: 'https://github.com/TheWidlarzGroup/react-native-video/tree/master/examples', + type: "link", + label: "Example Apps", + href: "https://github.com/TheWidlarzGroup/react-native-video/tree/master/example", }, { - type: 'doc', - label: 'Useful Projects', - id: 'projects', + type: "doc", + label: "Useful Projects", + id: "projects", }, { - type: 'html', - value: '
', + type: "html", + value: + '
', }, { - type: 'link', - label: 'Offline Video SDK', - href: 'https://www.thewidlarzgroup.com/offline-video-sdk/?utm_source=rnv&utm_medium=docs&utm_campaign=sidebar&utm_id=offline-video-sdk-button', + type: "link", + label: "Offline Video SDK", + href: "https://www.thewidlarzgroup.com/offline-video-sdk/?utm_source=rnv&utm_medium=docs&utm_campaign=sidebar&utm_id=offline-video-sdk-button", }, { - type: 'link', - label: 'Enterprise Support', - href: 'https://www.thewidlarzgroup.com/?utm_source=rnv&utm_medium=docs&utm_campaign=navbar&utm_id=enterprise#Contact', + type: "link", + label: "Enterprise Support", + href: "https://www.thewidlarzgroup.com/?utm_source=rnv&utm_medium=docs&utm_campaign=navbar&utm_id=enterprise#Contact", }, { - type: 'link', - label: 'Boost Your Issue', - href: 'https://www.thewidlarzgroup.com/issue-boost/?utm_source=rnv&utm_medium=docs&utm_campaign=sidebar&utm_id=issue-boost-button', + type: "link", + label: "Boost Your Issue", + href: "https://www.thewidlarzgroup.com/issue-boost/?utm_source=rnv&utm_medium=docs&utm_campaign=sidebar&utm_id=issue-boost-button", }, { - type: 'html', - value: '
', + type: "html", + value: + '
', }, { - type: 'doc', - label: 'Updating', - id: 'updating', + type: "doc", + label: "Updating", + id: "updating", }, { - type: 'link', - label: 'Releases', - href: 'https://github.com/TheWidlarzGroup/react-native-video/releases', - } + type: "link", + label: "Releases", + href: "https://github.com/TheWidlarzGroup/react-native-video/releases", + }, ], }; diff --git a/docs/versioned_sidebars/version-6.x-sidebars.json b/docs/versioned_sidebars/version-6.x-sidebars.json index 400bb1e5..400bb4ac 100644 --- a/docs/versioned_sidebars/version-6.x-sidebars.json +++ b/docs/versioned_sidebars/version-6.x-sidebars.json @@ -11,7 +11,7 @@ { "type": "link", "label": "Example Apps", - "href": "https://github.com/TheWidlarzGroup/react-native-video/tree/master/examples" + "href": "https://github.com/TheWidlarzGroup/react-native-video/tree/support/6.x.x/examples" }, { "type": "doc", @@ -49,7 +49,7 @@ { "type": "link", "label": "Changelog", - "href": "https://github.com/TheWidlarzGroup/react-native-video/blob/master/CHANGELOG.md" + "href": "https://github.com/TheWidlarzGroup/react-native-video/blob/support/6.x.x/CHANGELOG.md" } ] }