diff --git a/docs/API-Reference.md b/docs/API-Reference.md index 7a4ff54..1107d96 100644 --- a/docs/API-Reference.md +++ b/docs/API-Reference.md @@ -1,7 +1,6 @@ --- layout: default title: API Reference -nav_order: 3 --- {: .no_toc } diff --git a/docs/Android-Client.md b/docs/Android-Client.md index e7f9559..b9c58f5 100644 --- a/docs/Android-Client.md +++ b/docs/Android-Client.md @@ -1,18 +1,18 @@ --- layout: default title: Android Client -nav_order: 40 +parent: Legacy --- ## **IMPORTANT** * The original tt-rss-android project, hosted at and its various subdomains, - [will be gone after 2025-11-01](https://community.tt-rss.org/t/the-end-of-tt-rss-org/7164). + went away on 2025-11-01. * There are currently no plans to continue maintaining the app. * The app's source code may be found at . -* **APK downloads from are no longer working. This is likely permanent.** +* APKs that were available at are gone. * This page's content should only be treated as a historical reference. -* Refer to for more information. +* Refer to for more information. ## Screenshots diff --git a/docs/Archived-Feed.md b/docs/Archived-Feed.md index 43c0fdf..bbfdd8a 100644 --- a/docs/Archived-Feed.md +++ b/docs/Archived-Feed.md @@ -1,7 +1,7 @@ --- layout: default title: Archived Feed -nav_order: 41 +parent: Features --- Archived is the place for articles for which originating feed no longer exists. diff --git a/docs/Content-Filters.md b/docs/Content-Filters.md index 282ed7c..28bfb8a 100644 --- a/docs/Content-Filters.md +++ b/docs/Content-Filters.md @@ -1,7 +1,7 @@ --- layout: default title: Content Filters -nav_order: 20 +parent: Features --- Filters are a very powerful and flexible tool which may significantly ease the diff --git a/docs/Email-Digests.md b/docs/Email-Digests.md index 8f37590..8d44ac2 100644 --- a/docs/Email-Digests.md +++ b/docs/Email-Digests.md @@ -1,7 +1,7 @@ --- layout: default title: Email Digests -nav_order: 42 +parent: Features --- Users may opt into receiving daily (sent once every 24 hours) digests of unread headlines via email. diff --git a/docs/Encryption.md b/docs/Encryption.md index b4c9207..dab98c3 100644 --- a/docs/Encryption.md +++ b/docs/Encryption.md @@ -1,12 +1,14 @@ --- layout: default title: Encryption -nav_order: 43 +parent: Security --- -Transparent at rest encryption is optionally supported for sensitive data stored in the database, currently limited to stored session data and passwords for feeds with authentication enabled. +Transparent at-rest encryption is optionally supported for sensitive data stored in the database, +currently limited to stored session data and passwords for feeds with authentication enabled. -To enable, [global configuration](Global-Config) option `TTRSS_ENCRYPTION_KEY` should be set to a 32-byte hex string of random bytes, which may be generated using CLI like this: +To enable, [global configuration](Global-Config) option `TTRSS_ENCRYPTION_KEY` should be set to a 32-byte hex string of random bytes, +which may be generated using CLI like this: ```sh php ./update.php --gen-encryption-key @@ -15,4 +17,6 @@ php ./update.php --gen-encryption-key If enabled, existing plaintext login sessions are automatically encrypted when used, plaintext feed passwords are encrypted on feed update. {: .warning } -> Automatic encryption of plaintext data is a one-way process. If you decide to disable `TTRSS_ENCRYPTION_KEY` afterwards, all encrypted sessions would become invalid and you will get logged out. Feed passwords would become unreadable until you either enable encryption back using same key or edit feeds manually. +> Automatic encryption of plaintext data is a one-way process. If you decide to disable `TTRSS_ENCRYPTION_KEY` afterwards, all encrypted sessions would +> become invalid and you will get logged out. Feed passwords would become unreadable until you either enable encryption back using same key or edit feeds +> manually. diff --git a/docs/FAQ.md b/docs/FAQ.md index 999ddee..15a4233 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -1,7 +1,7 @@ --- layout: default title: FAQ -nav_order: 30 +nav_order: 3 --- {: .note } diff --git a/docs/Feed-Handler-Plugins.md b/docs/Feed-Handler-Plugins.md index 02dcb9d..5845a0d 100644 --- a/docs/Feed-Handler-Plugins.md +++ b/docs/Feed-Handler-Plugins.md @@ -1,7 +1,8 @@ --- layout: default title: Feed Handler Plugins -nav_order: 44 +parent: Plugins +nav_order: 2 --- {: .warning } diff --git a/docs/Generated-Feeds.md b/docs/Generated-Feeds.md index 86caff5..2b41ab5 100644 --- a/docs/Generated-Feeds.md +++ b/docs/Generated-Feeds.md @@ -1,7 +1,7 @@ --- layout: default title: Generated Feeds -nav_order: 45 +parent: Features --- You can generate a feed (in Atom or JSON format) for almost anything displayed diff --git a/docs/Global-Config.md b/docs/Global-Config.md index 8ac6139..caecb64 100644 --- a/docs/Global-Config.md +++ b/docs/Global-Config.md @@ -1,7 +1,7 @@ --- layout: default title: Global Configuration -nav_order: 21 +nav_order: 4 --- All settings (see `_DEFAULTS[]` for default values) are listed here: diff --git a/docs/Making-Plugins.md b/docs/Making-Plugins.md index 4515034..00e7d72 100644 --- a/docs/Making-Plugins.md +++ b/docs/Making-Plugins.md @@ -1,7 +1,8 @@ --- layout: default title: Making Plugins -nav_order: 11 +parent: Plugins +nav_order: 1 --- Plugins may render new preference panes or embed themselves into several diff --git a/docs/Publish-Articles.md b/docs/Publish-Articles.md index f2b546f..34710bc 100644 --- a/docs/Publish-Articles.md +++ b/docs/Publish-Articles.md @@ -1,7 +1,7 @@ --- layout: default title: Publish Articles -nav_order: 46 +parent: Features --- You can publish selected articles to a special RSS feed, accessible to anyone diff --git a/docs/SSL-Certificate-Authentication.md b/docs/SSL-Certificate-Authentication.md index cf8afa6..45f2897 100644 --- a/docs/SSL-Certificate-Authentication.md +++ b/docs/SSL-Certificate-Authentication.md @@ -1,7 +1,7 @@ --- layout: default title: SSL Certificate Authentication -nav_order: 52 +parent: Legacy --- {: .warning } diff --git a/docs/Scoring.md b/docs/Scoring.md index b801ad1..5fccc0c 100644 --- a/docs/Scoring.md +++ b/docs/Scoring.md @@ -1,7 +1,7 @@ --- layout: default title: Scoring -nav_order: 47 +parent: Features --- Scoring is supported in a way similar to some newsreaders. Score is calculated diff --git a/docs/Search-Syntax.md b/docs/Search-Syntax.md index 50ac096..45acce0 100644 --- a/docs/Search-Syntax.md +++ b/docs/Search-Syntax.md @@ -1,7 +1,6 @@ --- layout: default title: Search Syntax -nav_order: 48 --- {: .note } diff --git a/docs/Securing-Cache-Directories.md b/docs/Securing-Cache-Directories.md index 8b5a4a5..a9b2481 100644 --- a/docs/Securing-Cache-Directories.md +++ b/docs/Securing-Cache-Directories.md @@ -1,7 +1,7 @@ --- layout: default title: Securing Cache Directories -nav_order: 49 +parent: Security --- {: .note } diff --git a/docs/Share-Anything.md b/docs/Share-Anything.md index 4a635b0..21ea539 100644 --- a/docs/Share-Anything.md +++ b/docs/Share-Anything.md @@ -1,14 +1,14 @@ --- layout: default title: Share Anything -nav_order: 50 +parent: Features --- You can share arbitrary webpages to appear as articles in your ``Published`` feed. Combined with Readability this makes tt-rss function like a read it later kind of website. -Sharing is available via bookmarklet in Preferences: (`Feeds`-→ +Sharing is available via bookmarklet in Preferences: (`Feeds` → `Bookmarklets`) (if you have ``bookmarklets`` plugin enabled) or through Android application. diff --git a/docs/Sorting.md b/docs/Sorting.md index b7dff13..b3840f8 100644 --- a/docs/Sorting.md +++ b/docs/Sorting.md @@ -1,7 +1,7 @@ --- layout: default title: Sorting -nav_order: 51 +parent: Features --- Tiny Tiny RSS provides four options for how articles appear within a diff --git a/index.md b/index.md index 9022372..f036b5a 100644 --- a/index.md +++ b/index.md @@ -70,9 +70,8 @@ Browse the documentation: ## Development and Contributing -* Contributions (documentation improvements, translations, reporting issues, etc.) are welcome. -* Development and issue tracking primarily happens in [https://github.com/tt-rss/tt-rss](https://github.com/tt-rss/tt-rss). -* Help translate tt-rss into your own language using [Weblate](https://hosted.weblate.org/engage/tt-rss/). +Contributions (code, translations, reporting issues, etc.) are welcome. +Please see for more information. ---