Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
moskalakamil committed Dec 9, 2024
2 parents b77a1de + ee401cf commit 9ea9bca
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 3 deletions.
5 changes: 3 additions & 2 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ name: Deploy Documentation

on:
workflow_dispatch:
push:
branches:
- master
paths:
Expand All @@ -10,6 +11,8 @@ on:
jobs:
build_and_deploy_docs:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout repository
uses: actions/checkout@v3
Expand All @@ -34,5 +37,3 @@ jobs:
publish_dir: ./docs/build
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com
permissions:
contents: write
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ It is configured to use the local version of the library, so any changes you mak

You can use various commands from the root directory to work with the project.

#### Example
To start the packager:

```sh
Expand Down Expand Up @@ -68,6 +69,28 @@ Remember to add tests for your change if possible. Run the unit tests by:
yarn test
```

#### Documentation

To run the documentation locally, follow these steps:

1. Navigate to the docs folder:

```sh
cd docs
```

2. Install the dependencies:

```sh
yarn install
```

3. Start the documentation server:

```sh
yarn start
```

### Commit message convention

We follow the [conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages:
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Whether you're creating a social media app, an e-learning platform, or a media p
- [Api](/docs/category/api): Explore all available props, styles, and customization options.
- **Community**: Join our [Discord server](https://discord.gg/7Y6eE62hXM) to connect with other developers, ask questions, and share your feedback.
- [Roadmap](https://github.com/TheWidlarzGroup/react-native-video-player/discussions/186): See what’s coming next for this library.
- [Enterprise Support](https://www.thewidlarzgroup.com/?utm_source=rnvp&utm_medium=docs#Contact): Need professional help? Reach out for integration, customization, or maintenance support.
- [Enterprise Support](https://www.thewidlarzgroup.com/?utm_source=rnvp&utm_medium=docs#Contact): Need professional help such as custom video solutions? Contact us for integration, customization, or maintenance support.

We’re excited to have you onboard. Let’s build something awesome together! 🚀

Expand Down

0 comments on commit 9ea9bca

Please sign in to comment.