Skip to content

Commit

Permalink
Update README with correct steps to rebuild documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
artem-y-pamediagroup authored Jul 19, 2024
1 parent 4fe37f3 commit 3e8bec9
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,15 @@ By default the SDK uses system user agent, so if your app uses native URL Sessio
To update the documentation, follow these steps:

1. Make changes to the documentation code.
2. Build the documentation following the instructions in [this URL](https://swiftlang.github.io/swift-docc-plugin/documentation/swiftdoccplugin/publishing-to-github-pages/).
3. Merge the code into the `gh-pages` branch.

2. Build the documentation by running the convenience script from the root of this repository.
```sh
./generate_docc
```
or
```sh
sh generate_docc
```
Alternatively, follow the instructions at [this URL](https://swiftlang.github.io/swift-docc-plugin/documentation/swiftdoccplugin/publishing-to-github-pages/).
3. Commit and push the changes onto your branch.
4. Go to [GitHub Pages settings](https://github.com/StreamAMG/playback-sdk-ios/settings/pages), change the Branch in `Build and deployment` section to your branch and press "Save".
5. After merging, redo step 4 to re-deploy the documentation from the branch where it was merged to.

0 comments on commit 3e8bec9

Please sign in to comment.