Move all documentation to /docs/ directory
This commit is contained in:
parent
f458300f65
commit
f454944e43
7 changed files with 38 additions and 2 deletions
|
@ -2,6 +2,10 @@
|
||||||
Title: API
|
Title: API
|
||||||
Type: Document
|
Type: Document
|
||||||
---
|
---
|
||||||
|
---
|
||||||
|
|
||||||
|
import { Prism } from '@astrojs/prism';
|
||||||
|
|
||||||
## Generic
|
## Generic
|
||||||
**Language**
|
**Language**
|
||||||
|
|
||||||
|
@ -30,7 +34,8 @@ Enable or disable the Milieu mode.
|
||||||
|
|
||||||
When a user registered an account, it is processed with the following data:
|
When a user registered an account, it is processed with the following data:
|
||||||
|
|
||||||
```JSON
|
<Prism lang="json" code={
|
||||||
|
`
|
||||||
{
|
{
|
||||||
"name": "PROVIDED_NAME",
|
"name": "PROVIDED_NAME",
|
||||||
"ui_theme": "Default",
|
"ui_theme": "Default",
|
||||||
|
@ -44,7 +49,8 @@ When a user registered an account, it is processed with the following data:
|
||||||
"image_proxy": "https://ipx.sudovanilla.org",
|
"image_proxy": "https://ipx.sudovanilla.org",
|
||||||
"player_type": "Zorn"
|
"player_type": "Zorn"
|
||||||
}
|
}
|
||||||
```
|
`
|
||||||
|
} />
|
||||||
|
|
||||||
The end-user is then redirected to `/?=welcome` with an onboarding screen(Planned, this actually does nothing for now).
|
The end-user is then redirected to `/?=welcome` with an onboarding screen(Planned, this actually does nothing for now).
|
||||||
|
|
30
docs/faq.md
Normal file
30
docs/faq.md
Normal file
|
@ -0,0 +1,30 @@
|
||||||
|
## End-User FAQ
|
||||||
|
### Can I use MinPluto on this device?
|
||||||
|
|
||||||
|
For devices with a web browser built-in, MinPluto will run in it. However, MinPluto does not have a dedicated app for devices like Roku, Amazon Firestick, Google TV, and any other Smart TV device along with gaming consoles.
|
||||||
|
|
||||||
|
For mobile users, you can install MinPluto from your browser as an app, if the browser has that option.
|
||||||
|
|
||||||
|
### Will there be a Android/iOS app?
|
||||||
|
|
||||||
|
For now, MinPluto is planned to be only a web application that can be accessed via a web browser. There are currently no plans to build a mobile application.
|
||||||
|
|
||||||
|
### What data does MinPluto collect?
|
||||||
|
|
||||||
|
MinPluto by itself does not collect any data about you or any other user.
|
||||||
|
|
||||||
|
If you decide to opt-in to the telemtry, the Telemtry page will list what is logged and what is not logged.
|
||||||
|
|
||||||
|
However, please keep in mind that on other MinPluto instances, the instance operator can log your IP address like any other server could.
|
||||||
|
|
||||||
|
### What is a YouTube/Twitch frontend?
|
||||||
|
|
||||||
|
A frontend is it’s own UI and service that serves data from another platform such as YouTube, Twitch, X, Reddit, etc.
|
||||||
|
|
||||||
|
### Why use a different frontend and not use the real thing?
|
||||||
|
|
||||||
|
There are multiple reasons to use a frontend like MinPluto. Reasons such as like privacy, to avoid being tracked from invasive companies; speed, to avoid the bloated pages that these platforms have…frontend alternatives are commonly lightweight; and another reason is to avoid ads, all frontends don’t serve ads like these platforms do.
|
||||||
|
|
||||||
|
### Why is the player different for Twitch Streams?
|
||||||
|
|
||||||
|
In order to support playing live streams for MinPluto a technology known as HLS(HTTP Live Streaming) has to be added to a supported player, in this case VideoJS. Using your browser's built-in player will not work and this has not been tested for for MinPluto's custom player yet.
|
Loading…
Reference in a new issue