Skip to content

Fix: Update the Scalable Pixel Streaming Frontend Docs migration url and add utilisation and reference docs #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dan-tw merged 6 commits into from
Mar 15, 2023
Merged

Fix: Update the Scalable Pixel Streaming Frontend Docs migration url and add utilisation and reference docs #14

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b15a790
removed the monolithic docs file
adrianZahra Mar 15, 2023
306d666
added seperate docs files for each topic
adrianZahra Mar 15, 2023
a380f99
updated the readme to reflect the split docs
adrianZahra Mar 15, 2023
b27b397
added fixes to Utalising Readme sentence and fixed migration title
adrianZahra Mar 15, 2023
1b34343
fixed SPS abreviation
adrianZahra Mar 15, 2023
6e8f90a
changed the contents of utalising the frontend to make it flow better
adrianZahra Mar 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ The SPS frontend is a lightweight implementation of Epic Games' [Pixel Streaming
## Documentation

### Utilising the Scalable Pixel Streaming Frontend
Below for a comprehensive guide to accessing the Scalable Pixel Streaming Frontend, including where to download the library and how to consume and customise it for your own projects.
Below is a comprehensive guide to accessing the Scalable Pixel Streaming Frontend, including where to download the library and how to consume and customise it for your own projects.
- [Scalable Pixel Streaming Frontend utilisation guide](./docs/frontend_utilisation_guide.md)

### Migrating from Scalable Pixel Streaming frontend
### Migrating from Scalable Pixel Streaming Frontend
In general, the official Epic Games Pixel Streaming [Frontend docs](https://github.com/EpicGames/PixelStreamingInfrastructure/tree/master/Frontend) should cover most common usage cases (as our library is simply a thin wrapper on that). However, some SPS frontend specific docs are listed below:

- [Migrating from SPS frontend <=0.1.4](./docs/api_transition_guide.md)
- [Migrating from Scalable Pixel Streaming Frontend <=0.1.4](./docs/api_transition_guide.md)

### Scalable Pixel Streaming Frontend Reference section
The Scalable Pixel Streaming Frontend is a part of a complex system which abstracts a lot of its complexities behind the library. Below is a useful collection of references which explain how the Scalable Pixel Streaming Frontend fits within Scalable Pixel Streaming as a whole.
Expand Down