From df1bab76cdbac556e6df1447fadbd3e00c992505 Mon Sep 17 00:00:00 2001 From: Aminda Suomalainen Date: Mon, 14 Apr 2025 10:32:53 +0300 Subject: [PATCH] Add more ToCs --- Code-Quality.md | 17 +++++++++++++ How-to-create-your-own-FluffyChat-fork.md | 17 +++++++++++++ Push-Notifications-without-Google-Services.md | 19 +++++++++++++++ Release-Candidate-Public-Beta-Template.md | 24 +++++++++++++++++++ Translators-Guide.md | 16 +++++++++++++ 5 files changed, 93 insertions(+) diff --git a/Code-Quality.md b/Code-Quality.md index 88d7eb3..260c33a 100644 --- a/Code-Quality.md +++ b/Code-Quality.md @@ -2,6 +2,23 @@ FluffyChat tries to be as minimal as possible even in the code style. We try to keep the code clean, simple and easy to read. The source code of the app is under `/lib` with the main entry point `/lib/main.dart`. + + + + + +**Table of Contents** + +- [Directory Structure:](#directory-structure) +- [Separation of Controllers and Views](#separation-of-controllers-and-views) +- [Formatting](#formatting) +- [Code Analyzis](#code-analyzis) + + + + + + ### Directory Structure: diff --git a/How-to-create-your-own-FluffyChat-fork.md b/How-to-create-your-own-FluffyChat-fork.md index 5533b09..15e3a6e 100644 --- a/How-to-create-your-own-FluffyChat-fork.md +++ b/How-to-create-your-own-FluffyChat-fork.md @@ -1,3 +1,20 @@ + + + + + +**Table of Contents** + +- [1. License](#1-license) +- [2. Disable end-to-end encryption!](#2-disable-end-to-end-encryption) +- [3. Stay up to date!](#3-stay-up-to-date) +- [4. Official Support](#4-official-support) + + + + + + ## 1. License FluffyChat is licensed under AGPL. Read the license (https://github.com/krille-chan/fluffychat/blob/main/LICENSE) and diff --git a/Push-Notifications-without-Google-Services.md b/Push-Notifications-without-Google-Services.md index 8546e6c..75f041f 100644 --- a/Push-Notifications-without-Google-Services.md +++ b/Push-Notifications-without-Google-Services.md @@ -4,6 +4,25 @@ Push notifications are a great way to make sure you don't miss important message FluffyChat attempts to set up push notifications automatically every time you launch the app. However, if you do not have Google Services on your device, you may receive an error message. In this case, it is necessary to use the an [UnifiedPush app](https://unifiedpush.org/#quick-start) such as Ntfy, UP-FCM Distributor (Google) or Conversations. + + + + + +**Table of Contents** + +- [Using Ntfy](#using-ntfy) + - [🏪 Step 1: Installing and Setting Up ntfy](#-step-1-installing-and-setting-up-ntfy) + - [🔋 Step 2: Deactivate Battery Optimization for ntfy](#-step-2-deactivate-battery-optimization-for-ntfy) + - [✅ Step 3: Checking Push Configuration in FluffyChat](#-step-3-checking-push-configuration-in-fluffychat) + - [🥳 Step 4: Receiving Push Notifications](#%F0%9F%A5%B3-step-4-receiving-push-notifications) +- [Using Conversations](#using-conversations) + + + + + + ## Using Ntfy In this article, we'll show you how to configure push notifications on your Android device using the **ntfy** app. diff --git a/Release-Candidate-Public-Beta-Template.md b/Release-Candidate-Public-Beta-Template.md index 098b02a..33804c6 100644 --- a/Release-Candidate-Public-Beta-Template.md +++ b/Release-Candidate-Public-Beta-Template.md @@ -2,6 +2,30 @@ There are plenty of cases, which can not be tested easily in automated UI tests. We need to check all cases on the specified platforms. Please comment below, what you can confirm that it is (still) working or broken with the current release candidate. Also please report all regressions you can find. + + + + + +**Table of Contents** + + - [iOS / iPadOS](#ios--ipados) + - [Android](#android) + - [Linux Desktop](#linux-desktop) + - [Web version](#web-version) + - [Any platform](#any-platform) +- [How to join the public beta](#how-to-join-the-public-beta) + - [iOS and iPadOS](#ios-and-ipados) + - [Android](#android-1) + - [PlayStore](#playstore) + - [Linux Desktop (including Linux Phones)](#linux-desktop-including-linux-phones) + - [Web](#web) + + + + + + ## iOS / iPadOS 1. - [ ] App receives push notifications when it is in background/terminated diff --git a/Translators-Guide.md b/Translators-Guide.md index 4e9b304..5d65de2 100644 --- a/Translators-Guide.md +++ b/Translators-Guide.md @@ -1,5 +1,21 @@ There are 3 main types of strings to be translated. + + + + + +**Table of Contents** + +- [Simple](#simple) +- [Placeholder](#placeholder) +- [Plural](#plural) + + + + + + ## Simple ``` Add new friend