Bonsoir à tous,

voici le tant attendu plan pour la documentation ! Comme cela est déjà fait actuellement, la doc est séparée en doc utilisateurs / doc développeurs. On continue sur cette lancée !

À noter qu'il s'agit encore d'un brouillon qui sera amené à évoluer grâce à vos retours :) Certaines parties ne sont pas forcément encore bien détaillées parce que je n'y ai pas trop réfléchi (puis je suis fatigué). Si j'ai oublié des trucs, si vous pensez que ça s'enchaîne mal, si vous avez pleins d'idées, si c'est trop confus, lâchez vos commentaires !

Restera à écrire ce qui va bien sur le wiki :)

C'est parti !

Documentation utilisateur

Page principale
- FreshRSS = agrégateur de flux RSS trop cool
- Rapide rappel de ce qu'est un flux RSS (page à part ?)
- Fonctionnalités phares de FRSS
- Liens vers les autres points
Pour bien commencer
1. Choisir sa version (master / beta / dev)
2. Installer FRSS sur son serveur / mutualisé
  - Configuration requise / recommandée
  - Conseils et sécurité
Vue principale
1. Vue normale
  - Fonctionnalités basiques : marquer comme (non) lu / favoris
  - Naviguer dans les articles
  - La barre de menu
  - Voir l'article sur le site d'origine
  - Ordre de lecture
  - Actualiser les flux
2. Vue globale
  - Prévue pour tout voir d'un coup d'œil
  - Clic ouvre un pop-up pour lire rapidement les articles (même fonctionnalités que la vue normale)
3. Vue lecture
  - Prévue pour… faciliter la lecture !
  - Plus aucune fonctionnalité sauf navigation (article suivant / précédent) et voir sur site d'origine
4. Recherche et filtres
Gestion des abonnements
1. Ajouter un flux
2. Importer et exporter ses flux
  - Basique : fichier OPML
  - Importer ses fichiers Google Reader / FreshRSS (fichiers JSON)
  - Exporter liste OPML / articles favoris / articles des flux
3. Gestion des catégories (attention, ça va changer… un jour !)
4. Gestion des flux tronqués
Paramétrage
1. Personnaliser la vue
2. Options de lecture
3. Archivage
4. Raccourcis
5. Filtres
6. Authentification
  - Accès anonymes
  - Détails fonctionnalités en fonction de la méthode d'authentification
  - Gestion multi-utilisateurs
  - Configuration aux petits oignons
    - Présentation de différents "workflows"
Utiliser une application mobile
1. Paramétrage de l'API
2. Liste des applications (EasyRSS, News+)
Remonter un problème / une suggestion
- Tickets Github
- Comment bien présenter sa demande (notamment donner les logs PHP / FRSS pertinents)

Documentation développeurs

Page principale
- Bienvenue et merci de l'intérêt pour FRSS
- Différents moyens pour contribuer (testeurs / dev backend / dev frontend / optimisation perf / proposer fonctionnalités / etc.)
- Liens vers les autres points
Par où commencer ?
1. Configurer son environnement de développement
  - Apache+MySQL = Docker
  - Git et Github
  - Config avec no-cache.txt et la valeur "environment")
2. Architecture du projet
  - Les grandes parties du code (comment est-il rangé ?)
3. Coding style
Github
1. Remonter un bug / une suggestion
2. Système de branches
3. Proposer un patch
Backend
1. Schéma base de données
2. Minz
  1. Models
  2. Controllers et actions
  3. Views
  4. Routage (paramètres c et a)
  5. Écriture des URL (Minz_Url::display et raccourci)
  6. Internationalisation (Minz_Translate::t et raccourci)
  7. Comprendre les mécanismes internes
    - FrontController
    - Request
    - Dispatcher
3. Librairies externes
  - SimplePie and co
4. Modifier le code
  1. Accès aux informations de la base de données
  2. Écrire une action avec une vue associée
  3. Gestion authentification
  4. Gestion des logs
Frontend
1. Les fichiers de vue
  - Les fichiers .phtml
  - Écrire URLs (_url())
  - Afficher les icônes (_i())
  - Gestion de l'internationalisation (_t())
2. Design
  - Système fichier template
  - Écrire un nouveau thème
  - Dépôt FreshRSS-base-theme
  - "Surcharger" les icônes (répertoire icons)

Uh oh!

Documentation #123

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions