From f454944e4311a0270476fd25978d596eb413c6ac Mon Sep 17 00:00:00 2001 From: Korbs Date: Tue, 12 Nov 2024 19:17:37 -0500 Subject: [PATCH] Move all documentation to /docs/ directory --- API.mdx => docs/api.mdx | 10 +++++-- compatibility.mdx => docs/compatibility.mdx | 0 docs/faq.md | 30 +++++++++++++++++++++ introduction.mdx => docs/introduction.mdx | 0 requirements.mdx => docs/requirements.mdx | 0 self-hosting.mdx => docs/self-hosting.mdx | 0 support.mdx => docs/support.mdx | 0 7 files changed, 38 insertions(+), 2 deletions(-) rename API.mdx => docs/api.mdx (94%) rename compatibility.mdx => docs/compatibility.mdx (100%) create mode 100644 docs/faq.md rename introduction.mdx => docs/introduction.mdx (100%) rename requirements.mdx => docs/requirements.mdx (100%) rename self-hosting.mdx => docs/self-hosting.mdx (100%) rename support.mdx => docs/support.mdx (100%) diff --git a/API.mdx b/docs/api.mdx similarity index 94% rename from API.mdx rename to docs/api.mdx index d6dfb96..3a60b59 100644 --- a/API.mdx +++ b/docs/api.mdx @@ -2,6 +2,10 @@ Title: API Type: Document --- +--- + +import { Prism } from '@astrojs/prism'; + ## Generic **Language** @@ -30,7 +34,8 @@ Enable or disable the Milieu mode. When a user registered an account, it is processed with the following data: -```JSON + The end-user is then redirected to `/?=welcome` with an onboarding screen(Planned, this actually does nothing for now). diff --git a/compatibility.mdx b/docs/compatibility.mdx similarity index 100% rename from compatibility.mdx rename to docs/compatibility.mdx diff --git a/docs/faq.md b/docs/faq.md new file mode 100644 index 0000000..1b69ad4 --- /dev/null +++ b/docs/faq.md @@ -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. \ No newline at end of file diff --git a/introduction.mdx b/docs/introduction.mdx similarity index 100% rename from introduction.mdx rename to docs/introduction.mdx diff --git a/requirements.mdx b/docs/requirements.mdx similarity index 100% rename from requirements.mdx rename to docs/requirements.mdx diff --git a/self-hosting.mdx b/docs/self-hosting.mdx similarity index 100% rename from self-hosting.mdx rename to docs/self-hosting.mdx diff --git a/support.mdx b/docs/support.mdx similarity index 100% rename from support.mdx rename to docs/support.mdx