Skip to content

Commit aedd603

Browse files
committed
Start addressing super-linter findings.
1 parent a403b97 commit aedd603

File tree

12 files changed

+190
-198
lines changed

12 files changed

+190
-198
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Tiny Tiny RSS Documentation Site
22

3-
This repository contains the source for the https://tt-rss.github.io.
3+
This repository contains the source for <https://tt-rss.github.io>.
44

55
## License
66

@@ -44,7 +44,7 @@ bundle exec jekyll serve
4444

4545
## Structure
4646

47-
```
47+
```text
4848
tt-rss.github.io/
4949
├── _config.yml # Jekyll configuration
5050
├── index.md # Homepage

docs/API-Reference.md

Lines changed: 74 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -67,20 +67,19 @@ All API methods return JSON data like this:
6767
{"seq":0,"status":0,"content":{"version":"1.4.3.1"}}
6868
```
6969

70-
- seq (integer) is the sequence number supplied by client (``"seq":131``)
71-
- status (integer) indicates whether request has been completed
72-
successfully, can be either 0 (API\_STATUS\_OK) or 1
73-
(API\_STATUS\_ERR)
74-
- content is the actual reply content, as documented below in method
75-
descriptions.
70+
- seq (integer) is the sequence number supplied by client (``"seq":131``)
71+
- status (integer) indicates whether request has been completed
72+
successfully, can be either 0 (API\_STATUS\_OK) or 1
73+
(API\_STATUS\_ERR)
74+
- content is the actual reply content, as documented below in method
75+
descriptions.
7676

77-
##### 1.4.3 and below (obsolete)
77+
#### 1.4.3 and below (obsolete)
7878

79-
Methods return the content object below, sequence numbers and statuses
79+
Methods return the "content" object below, sequence numbers and statuses
8080
are not supported.
8181

82-
Methods
83-
-------
82+
## Methods
8483

8584
### getApiLevel (since version:1.5.8, api level-1)
8685

@@ -108,8 +107,8 @@ use this to detect API functionality, please use getApiLevel instead.
108107

109108
Parameters:
110109

111-
- ``user`` (string)
112-
- ``password`` (string)
110+
- ``user`` (string)
111+
- ``password`` (string)
113112

114113
Returns client session ID.
115114

@@ -119,12 +118,12 @@ Returns client session ID.
119118

120119
It can also return several error objects:
121120

122-
- If API is disabled for this user:
123-
<code>error: "API_DISABLED"</code>
124-
- If specified username and password are incorrect:
125-
<code>error: "LOGIN_ERROR"</code>
121+
- If API is disabled for this user:
122+
<code>error: "API_DISABLED"</code>
123+
- If specified username and password are incorrect:
124+
<code>error: "LOGIN_ERROR"</code>
126125

127-
In case it isnt immediately obvious, you have to login and get a
126+
In case it isn't immediately obvious, you have to login and get a
128127
session ID even if you are using single user mode. You can omit user and
129128
password parameters.
130129

@@ -153,24 +152,18 @@ Returns an integer value of currently unread articles.
153152
{"unread":"992"}
154153
```
155154

156-
### getCounters
157-
158-
Returns JSON-encoded counter information. Requires version:1.5.0.
159-
160-
* ``output_mode`` (string, default:-flc) - what kind of information to return (f - feeds, l - labels, c - categories, t --tags)
161-
162155
### getFeeds
163156

164157
Returns JSON-encoded list of feeds. The list includes category id,
165158
title, feed url, etc.
166159

167160
Parameters:
168161

169-
- ``cat_id`` (integer) - return feeds under category cat\_id
170-
- ``unread_only`` (bool) - only return feeds which have unread articles
171-
- ``limit`` (integer) - limit amount of feeds returned to this value
172-
- ``offset`` (integer) - skip this amount of feeds first
173-
- ``include_nested`` (bool) - include child categories (as Feed-objects
162+
- ``cat_id`` (integer) - return feeds under category cat\_id
163+
- ``unread_only`` (bool) - only return feeds which have unread articles
164+
- ``limit`` (integer) - limit amount of feeds returned to this value
165+
- ``offset`` (integer) - skip this amount of feeds first
166+
- ``include_nested`` (bool) - include child categories (as Feed-objects
174167
``with is_cat set)`` **requires version:1.6.0**
175168

176169
Pagination:
@@ -187,8 +180,8 @@ Special category IDs are as follows:
187180

188181
Added in version:1.5.0:
189182

190-
- -3 All feeds, excluding virtual feeds (e.g. Labels and-such)
191-
- -4 All feeds, including virtual feeds
183+
- -3 All feeds, excluding virtual feeds (e.g. Labels and-such)
184+
- -4 All feeds, including virtual feeds
192185

193186
Known bug: Prior to version:1.5.0 passing null or 0 cat\_id to this
194187
method returns full list of feeds instead of Uncategorized feeds only.
@@ -197,11 +190,11 @@ method returns full list of feeds instead of Uncategorized feeds only.
197190

198191
Returns JSON-encoded list of categories with unread counts.
199192

200-
- ``unread_only`` (bool) - only return categories which have unread
193+
- ``unread_only`` (bool) - only return categories which have unread
201194
articles
202-
- ``enable_nested`` (bool) - switch to nested mode, only returns topmost
195+
- ``enable_nested`` (bool) - switch to nested mode, only returns topmost
203196
categories **requires version:1.6.0**
204-
- ``include_empty`` (bool) - include empty categories **requires
197+
- ``include_empty`` (bool) - include empty categories **requires
205198
version:1.7.6**
206199

207200
Nested mode in this case means that a flat list of **only** topmost
@@ -218,30 +211,30 @@ Returns JSON-encoded list of headlines.
218211

219212
Parameters:
220213

221-
- ``feed_id`` (integer|string) - only output articles for this feed (supports string values to retrieve tag virtual feeds since API level 18, otherwise-integer)
222-
- ``limit`` (integer) - limits the amount of returned articles (see-below)
223-
- ``skip`` (integer) - skip this amount of feeds first
224-
- ``filter`` (string) - currently unused (?)
225-
- ``is_cat`` (bool) - requested feed\_id is a category
226-
- ``show_excerpt`` (bool) - include article excerpt in the output
227-
- ``show_content`` (bool) - include full article text in the output
228-
- ``view_mode`` (string = all\_articles, unread, adaptive,-marked,
214+
- ``feed_id`` (integer|string) - only output articles for this feed (supports string values to retrieve tag virtual feeds since API level 18, otherwise-integer)
215+
- ``limit`` (integer) - limits the amount of returned articles (see-below)
216+
- ``skip`` (integer) - skip this amount of feeds first
217+
- ``filter`` (string) - currently unused (?)
218+
- ``is_cat`` (bool) - requested feed\_id is a category
219+
- ``show_excerpt`` (bool) - include article excerpt in the output
220+
- ``show_content`` (bool) - include full article text in the output
221+
- ``view_mode`` (string = all\_articles, unread, adaptive,-marked,
229222
updated)
230-
- ``include_attachments`` (bool) - include article attachments (e.g.
223+
- ``include_attachments`` (bool) - include article attachments (e.g.
231224
enclosures) **requires version:1.5.3**
232-
- ``since_id`` (integer) - only return articles with id greater than
225+
- ``since_id`` (integer) - only return articles with id greater than
233226
``since_id`` **requires version:1.5.6**
234-
- ``include_nested`` (boolean) - include articles from child categories
227+
- ``include_nested`` (boolean) - include articles from child categories
235228
**requires version:1.6.0**
236-
- ``order_by`` (string) - override default sort order **requires
229+
- ``order_by`` (string) - override default sort order **requires
237230
version:1.7.6**
238-
- ``sanitize`` (bool) - sanitize content or not **requires version:1.8**
231+
- ``sanitize`` (bool) - sanitize content or not **requires version:1.8**
239232
(default:-true)
240-
- ``force_update`` (bool) - try to update feed before showing headlines
233+
- ``force_update`` (bool) - try to update feed before showing headlines
241234
**requires version:1.14 (api-9)** (default:-false)
242-
- ``has_sandbox`` (bool) - indicate support for sandboxing of iframe
235+
- ``has_sandbox`` (bool) - indicate support for sandboxing of iframe
243236
elements **<span class="10 api"></span>** (default:-false)
244-
- ``include_header`` (bool) - adds status information when returning
237+
- ``include_header`` (bool) - adds status information when returning
245238
headlines, instead of array(articles) return value changes to
246239
array(header,-array(articles)) (api-12)
247240

@@ -253,38 +246,38 @@ Before **API level 6** maximum amount of returned headlines is capped at
253246
This parameters might change in the future (supported since **API-level
254247
2**):
255248

256-
- ``search`` (string) - search query (e.g. a list of-keywords)
257-
- ``search_mode`` (string) - all\_feeds, this\_feed (default), this\_cat
249+
- ``search`` (string) - search query (e.g. a list of-keywords)
250+
- ``search_mode`` (string) - all\_feeds, this\_feed (default), this\_cat
258251
(category containing requested-feed)
259-
- ``match_on`` (string) - ignored
252+
- ``match_on`` (string) - ignored
260253

261254
Special feed IDs are as follows:
262255

263-
- -1 starred
264-
- -2 published
265-
- -3 fresh
266-
- -4 all articles
267-
- 0 - archived
268-
- IDs \< -10 labels
256+
- -1 starred
257+
- -2 published
258+
- -3 fresh
259+
- -4 all articles
260+
- 0 - archived
261+
- IDs \< -10 labels
269262

270263
Sort order values:
271264

272-
- ``date_reverse`` - oldest first
273-
- ``feed_dates`` - newest first, goes by feed date
274-
- ``(nothing)`` - default
265+
- ``date_reverse`` - oldest first
266+
- ``feed_dates`` - newest first, goes by feed date
267+
- ``(nothing)`` - default
275268

276269
### updateArticle
277270

278271
Update information on specified articles.
279272

280273
Parameters:
281274

282-
- ``article_ids`` (comma-separated list of-integers) - article IDs to
275+
- ``article_ids`` (comma-separated list of-integers) - article IDs to
283276
operate on
284-
- ``mode`` (integer) - type of operation to perform (0 - set to false, 1--
277+
- ``mode`` (integer) - type of operation to perform (0 - set to false, 1--
285278
set to true, 2 - toggle)
286-
- ``field`` (integer) - field to operate on (0 - starred, 1 - published, 2 - unread, 3 - article note **since api level-1**)
287-
- ``data`` (string) - optional data parameter when setting note field
279+
- ``field`` (integer) - field to operate on (0 - starred, 1 - published, 2 - unread, 3 - article note **since api level-1**)
280+
- ``data`` (string) - optional data parameter when setting note field
288281
(since **api level-1**)
289282

290283
E.g. to set unread status of articles X and Y to false use the
@@ -304,7 +297,7 @@ Since version:1.5.0 returns a status message:
304297

305298
Requests JSON-encoded article object with specific ID.
306299

307-
- ``article_id`` (integer) - article ID to return **as of 15.10.2010
300+
- ``article_id`` (integer) - article ID to return **as of 15.10.2010
308301
git** or version:1.5.0 supports comma-separated list of IDs
309302

310303
Since version:1.4.3 also returns article attachments.
@@ -317,20 +310,20 @@ Returns tt-rss configuration parameters:
317310
{"icons_dir":"icons","icons_url":"icons","daemon_is_running":true,"num_feeds":71}
318311
```
319312

320-
- ``icons_dir`` - path to icons on the server filesystem
321-
- ``icons_url`` - path to icons when requesting them over http
322-
- ``daemon_is_running`` - whether update daemon is running
323-
- ``num_feeds`` - amount of subscribed feeds (this can be used to-refresh
313+
- ``icons_dir`` - path to icons on the server filesystem
314+
- ``icons_url`` - path to icons when requesting them over http
315+
- ``daemon_is_running`` - whether update daemon is running
316+
- ``num_feeds`` - amount of subscribed feeds (this can be used to-refresh
324317
feedlist when this amount changes)
325-
- ``custom_sort_types`` - map of plugin-provided article sort types (API-17+)
318+
- ``custom_sort_types`` - map of plugin-provided article sort types (API-17+)
326319

327320
### updateFeed
328321

329322
Tries to update specified feed. This operation is not performed in the
330323
background, so it might take considerable time and, potentially, be
331324
aborted by the HTTP server.
332325

333-
- ``feed_id`` (integer) - ID of feed to update
326+
- ``feed_id`` (integer) - ID of feed to update
334327

335328
Returns status-message if the operation has been completed.
336329

@@ -342,7 +335,7 @@ Returns status-message if the operation has been completed.
342335

343336
Returns preference value of specified key.
344337

345-
- ``pref_name`` (string) - preference key to return value of
338+
- ``pref_name`` (string) - preference key to return value of
346339

347340
```json
348341
{"value":true}
@@ -356,9 +349,9 @@ Tries to catchup (e.g. mark as-read) specified feed.
356349

357350
Parameters:
358351

359-
- ``feed_id`` (integer) - ID of feed to update
360-
- ``is_cat`` (boolean) - true if the specified feed\_id is a category
361-
- ``mode`` (string) - optional: one of `all`, `1day`, `1week`, `2week`. defaults to `all`. **since api level 15**.
352+
- ``feed_id`` (integer) - ID of feed to update
353+
- ``is_cat`` (boolean) - true if the specified feed\_id is a category
354+
- ``mode`` (string) - optional: one of `all`, `1day`, `1week`, `2week`. defaults to `all`. **since api level 15**.
362355

363356
Returns status-message if the operation has been completed.
364357

@@ -374,15 +367,15 @@ Returns a list of unread article counts for specified feed groups.
374367

375368
Parameters:
376369

377-
- ``output_mode`` (string) - Feed groups to return counters for
370+
- ``output_mode`` (string) - Feed groups to return counters for
378371

379372
Output mode is a character string, comprising several letters (defaults
380373
to “flc”):
381374

382-
- f - actual feeds
383-
- l - labels
384-
- c - categories
385-
- t - tags
375+
- f - actual feeds
376+
- l - labels
377+
- c - categories
378+
- t - tags
386379

387380
Several global counters are returned as well, those can’t be disabled
388381
with output\_mode.

docs/Android-Client.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,25 @@ nav_order: 40
66

77
## **IMPORTANT**
88

9-
* The original tt-rss-android project, hosted at https://tt-rss.org/ and its various subdomains,
9+
* The original tt-rss-android project, hosted at <https://tt-rss.org/> and its various subdomains,
1010
[will be gone after 2025-11-01](https://community.tt-rss.org/t/the-end-of-tt-rss-org/7164).
1111
* There are currently no plans to continue maintaining the app.
12-
* The app's source code may be found at https://github.com/tt-rss/tt-rss-android .
13-
* **APK downloads from https://gitlab.tt-rss.org/tt-rss/tt-rss-android/-/releases are no longer working. This is likely permanent.**
12+
* The app's source code may be found at <https://github.com/tt-rss/tt-rss-android>.
13+
* **APK downloads from <https://gitlab.tt-rss.org/tt-rss/tt-rss-android/-/releases> are no longer working. This is likely permanent.**
1414
* This page's content should only be treated as a historical reference.
15-
* Refer to https://github.com/tt-rss/tt-rss/discussions/29 for more information.
15+
* Refer to <https://github.com/tt-rss/tt-rss/discussions/29> for more information.
1616

1717
## Screenshots
1818

19-
[<img src="images/tt-rss-android/Screenshot_20250509_135136.webp" width="120" align="left">](images/tt-rss-android/Screenshot_20250509_135136.webp)
19+
[<img src="images/tt-rss-android/Screenshot_20250509_135136.webp" width="120" align="left" alt="Android app main feed view">](images/tt-rss-android/Screenshot_20250509_135136.webp)
2020

21-
[<img src="images/tt-rss-android/Screenshot_20250509_135154.webp" width="120" align="left">](images/tt-rss-android/Screenshot_20250509_135154.webp)
21+
[<img src="images/tt-rss-android/Screenshot_20250509_135154.webp" width="120" align="left" alt="Android app article list">](images/tt-rss-android/Screenshot_20250509_135154.webp)
2222

23-
[<img src="images/tt-rss-android/Screenshot_20250509_135217.webp" width="120" align="left">](images/tt-rss-android/Screenshot_20250509_135217.webp)
23+
[<img src="images/tt-rss-android/Screenshot_20250509_135217.webp" width="120" align="left" alt="Android app article view">](images/tt-rss-android/Screenshot_20250509_135217.webp)
2424

25-
[<img src="images/tt-rss-android/Screenshot_20250509_135426.webp" width="120" align="left">](images/tt-rss-android/Screenshot_20250509_135426.webp)
25+
[<img src="images/tt-rss-android/Screenshot_20250509_135426.webp" width="120" align="left" alt="Android app settings">](images/tt-rss-android/Screenshot_20250509_135426.webp)
2626

27-
[<img src="images/tt-rss-android/Screenshot_20250509_135438.webp" width="120">](images/tt-rss-android/Screenshot_20250509_135438.webp)
27+
[<img src="images/tt-rss-android/Screenshot_20250509_135438.webp" width="120" alt="Android app preferences">](images/tt-rss-android/Screenshot_20250509_135438.webp)
2828

2929
## Download
3030

@@ -55,7 +55,7 @@ When adding new application in Obtainium, paste [app project page](https://gitla
5555

5656
### I want to help test the app! Are there development builds available?
5757

58-
Sometimes. Releases are not created for signed non-master branch builds, you can get the APKs from build pipeline artifacts [here](https://gitlab.tt-rss.org/tt-rss/tt-rss-android/-/jobs) - look for `build-signed-branch-apk`. Non-master builds install as a separate application with a gray icon.
58+
Sometimes. Releases are not created for signed non-master branch builds, you can get the APKs from [build pipeline artifacts](https://gitlab.tt-rss.org/tt-rss/tt-rss-android/-/jobs) - look for `build-signed-branch-apk`. Non-master builds install as a separate application with a gray icon.
5959

6060
### Why are you not on Google Play?
6161

0 commit comments

Comments
 (0)