Skip to content

Commit 2c543f3

Browse files
authored
docs(guide): add initial content for introduction, installation, gestures, and backups (#10)
1 parent d8b89f3 commit 2c543f3

File tree

11 files changed

+164
-6
lines changed

11 files changed

+164
-6
lines changed

docs/.vitepress/en.mts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,22 @@ export const en = defineConfig({
2020
text: "Introduction",
2121
link: "/user-guide/introduction",
2222
},
23+
{
24+
text: "Installation",
25+
link: "/user-guide/installation",
26+
},
2327
{
2428
text: "Core Features",
2529
link: "/user-guide/core-features",
2630
},
31+
{
32+
text: "Playback Gestures",
33+
link: "/user-guide/playback-gestures",
34+
},
35+
{
36+
text: "Backup and Restore",
37+
link: "/user-guide/backup-and-restore",
38+
},
2739
],
2840
},
2941
],

docs/.vitepress/fr.mts

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,22 @@ export const fr = defineConfig({
2424
text: "Introduction",
2525
link: "/fr/user-guide/introduction",
2626
},
27+
{
28+
text: "Installation",
29+
link: "/fr/user-guide/installation",
30+
},
2731
{
2832
text: "Fonctionnalités Clés",
2933
link: "/fr/user-guide/core-features",
3034
},
35+
{
36+
text: "Gestes de Lecture",
37+
link: "/fr/user-guide/playback-gestures",
38+
},
39+
{
40+
text: "Sauvegarde et Restauration",
41+
link: "/fr/user-guide/backup-and-restore",
42+
},
3143
],
3244
},
3345
],
@@ -76,7 +88,7 @@ export const fr = defineConfig({
7688

7789
footer: {
7890
message: "Publié sous la licence GNU AGPL v3.",
79-
copyright: "Copyright © 2025-present Priveetee",
91+
copyright: "Copyright © 2025-present PipePipe",
8092
},
8193

8294
editLink: {
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Sauvegarde et Restauration
2+
3+
Toutes vos données dans PipePipe (abonnements, historique, playlists) sont stockées localement sur votre appareil. L'application ne dépend d'aucun service cloud. C'est excellent pour la confidentialité, mais cela signifie que vous êtes responsable de vos propres sauvegardes.
4+
5+
## Créer une Sauvegarde
6+
7+
Il est fortement recommandé de sauvegarder vos données régulièrement.
8+
9+
1. Ouvrez le menu principal (icône hamburger en haut à gauche).
10+
2. Allez dans `Paramètres` > `Sauvegarde`.
11+
3. Appuyez sur `Exporter la base de données`.
12+
4. Le gestionnaire de fichiers de votre téléphone s'ouvrira. Naviguez vers un emplacement sûr pour enregistrer votre fichier de sauvegarde.
13+
14+
::: tip Bonne Pratique
15+
Créez un dossier dédié pour vos sauvegardes, par exemple, à l'intérieur de votre dossier `Documents`, et nommez-le `Backup_PipePipe`. Cela facilitera la recherche de vos sauvegardes plus tard.
16+
:::
17+
18+
::: warning
19+
Créez toujours une sauvegarde avant de mettre à jour l'application. C'est aussi une bonne habitude d'en créer une toutes les deux semaines ou tous les mois.
20+
:::

docs/fr/user-guide/installation.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Installation
2+
3+
PipePipe n'est pas disponible sur le Google Play Store. Vous pouvez l'installer depuis l'une des sources officielles et sécurisées suivantes.
4+
5+
::: tip F-Droid (Recommandé)
6+
F-Droid est un catalogue d'applications open-source. L'installation via le client officiel F-Droid est la méthode recommandée car elle gère les mises à jour automatiques.
7+
8+
[Obtenir sur F-Droid](https://f-droid.org/packages/InfinityLoop1309.NewPipeEnhanced/)
9+
:::
10+
11+
### IzzyOnDroid
12+
13+
IzzyOnDroid est un autre dépôt F-Droid de confiance qui propose souvent des versions plus récentes des applications.
14+
15+
[Obtenir sur IzzyOnDroid](https://apt.izzysoft.de/fdroid/index/apk/InfinityLoop1309.NewPipeEnhanced)
16+
17+
### GitHub
18+
19+
Vous pouvez toujours télécharger le dernier fichier `.apk` directement depuis la page des "releases" du projet sur GitHub.
20+
21+
::: warning
22+
Cette méthode vous oblige à vérifier et à installer les mises à jour manuellement.
23+
:::
24+
25+
[Télécharger depuis GitHub](https://github.com/InfinityLoop1308/PipePipe/releases)

docs/fr/user-guide/introduction.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1-
# Premiers Pas
1+
# Introduction
22

3-
Bienvenue sur le Wiki de PipePipe !
3+
PipePipe est un "fork" (une version dérivée) moderne et riche en fonctionnalités de la populaire application NewPipe. Il est conçu pour être plus rapide, plus stable et doté de plus de fonctionnalités.
4+
5+
## À propos de ce Fork
6+
7+
PipePipe a été créé à partir de NewPipe au début de l'année 2022. En raison de philosophies de développement différentes, les projets sont maintenant développés de manière indépendante.
8+
9+
Cela signifie que PipePipe ne reçoit pas de mises à jour de NewPipe et n'envoie pas non plus de mises à jour à NewPipe. Ce sont devenus deux projets distincts. Cette approche de "hard fork" permet des corrections rapides et des mises à jour fréquentes des fonctionnalités.
10+
11+
## Fonctionnalités Clés
12+
13+
- **Améliorations YouTube :** Intégration de SponsorBlock, restauration des "dislikes" YouTube, et affichage des titres originaux (non localisés).
14+
- **Fonctionnalités Média :** Affichage du chat en direct en style "danmaku", support des codecs AV1/VP9, et un mode lecteur de musique dédié.
15+
- **Filtrage Avancé :** Filtrez les "shorts", les vidéos payantes, et le contenu par mots-clés ou par chaîne.
16+
- **Contrôles de Lecture :** Gestes de balayage intuitifs, appui long pour accélérer la lecture, et une minuterie de mise en veille.
17+
- **Playlists Améliorées :** Téléchargez des playlists entières et profitez de la recherche et du tri avancés dans vos listes locales.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Gestes de Lecture
2+
3+
Maîtriser les gestes de lecture de PipePipe est la clé d'une expérience utilisateur fluide. Tous les gestes s'effectuent en balayant directement sur le lecteur vidéo.
4+
5+
- **Passer en plein écran :** Balayez vers le haut sur la vidéo.
6+
- **Quitter le plein écran :** Balayez vers le bas sur la vidéo.
7+
- **Ajuster la luminosité :** Balayez vers le haut ou le bas sur le côté **gauche** de l'écran.
8+
- **Ajuster le volume :** Balayez vers le haut ou le bas sur le côté **droit** de l'écran.

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ hero:
88
actions:
99
- theme: brand
1010
text: Get Started
11-
link: /guide/getting-started
11+
link: /user-guide/introduction.md
1212
- theme: alt
1313
text: View on GitHub
1414
link: https://github.com/InfinityLoop1308/PipePipe
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Backup and Restore
2+
3+
All your data in PipePipe (subscriptions, history, playlists) is stored locally on your device. The app does not depend on any cloud service. This is great for privacy, but it means you are responsible for your own backups.
4+
5+
## Creating a Backup
6+
7+
It is highly recommended to back up your data regularly.
8+
9+
1. Open the main menu (hamburger icon in the top left).
10+
2. Go to `Settings` > `Backup`.
11+
3. Tap `Export Database`.
12+
4. Your phone's file manager will open. Navigate to a safe location to save your backup file.
13+
14+
::: tip Best Practice
15+
Create a dedicated folder for your backups, for example, inside your `Documents` folder, named `Backup_PipePipe`. This makes it easy to find your backups later.
16+
:::
17+
18+
::: warning
19+
Always create a backup before updating the application. It's also a good habit to create one every few weeks.
20+
:::

docs/user-guide/installation.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Installation
2+
3+
PipePipe is not available on the Google Play Store. You can install it from one of the following official and safe sources.
4+
5+
::: tip F-Droid (Recommended)
6+
F-Droid is an open-source catalog of applications. Installing from the official F-Droid client is the recommended method as it provides automatic updates.
7+
8+
[Get it on F-Droid](https://f-droid.org/packages/InfinityLoop1309.NewPipeEnhanced/)
9+
:::
10+
11+
### IzzyOnDroid
12+
13+
IzzyOnDroid is another trusted F-Droid repository that often has more recent versions of applications.
14+
15+
[Get it on IzzyOnDroid](https://apt.izzysoft.de/fdroid/index/apk/InfinityLoop1309.NewPipeEnhanced)
16+
17+
### GitHub
18+
19+
You can always download the latest `.apk` file directly from the project's official GitHub releases page.
20+
21+
::: warning
22+
This method requires you to manually check for and install updates.
23+
:::
24+
25+
[Download from GitHub](https://github.com/InfinityLoop1308/PipePipe/releases)

docs/user-guide/introduction.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1-
# Getting Started
1+
# Introduction
22

3-
Welcome to the PipePipe Wiki!
3+
PipePipe is a modern, feature-rich fork of the popular NewPipe application. It is designed to be faster, more stable, and packed with more features.
4+
5+
## About this Fork
6+
7+
PipePipe was forked from NewPipe in early 2022. Due to differences in development philosophy, the projects are now developed independently.
8+
9+
This means that PipePipe neither receives updates from NewPipe nor pushes updates to NewPipe. They have become two separate projects. This "hard fork" approach allows for quick fixes and frequent feature updates.
10+
11+
## Key Features
12+
13+
- **YouTube Enhancements:** Integrate SponsorBlock, restore YouTube dislikes, and show original (non-localized) titles.
14+
- **Media Features:** Danmaku-style live chat overlays, AV1/VP9 codec support, and a dedicated music player mode.
15+
- **Advanced Filtering:** Filter out shorts, paid videos, and content by keywords or channels.
16+
- **Playback Controls:** Intuitive swipe gestures, long-press to speed up, and a sleep timer.
17+
- **Enhanced Playlists:** Download entire playlists and enjoy advanced searching and sorting within local lists.

0 commit comments

Comments
 (0)