Commit Graph

16 Commits

Author SHA1 Message Date
polybjorn
b08c4ef243 docs: standardise English heading style and surface hidden pages (#8766)
Apply sentence case to all H1s in docs/en/ and remove redundant "FreshRSS"
from titles where the docs site context already implies it. Align the three
section index titles to "Administrator/Developer/User manual", matching
the existing root H1 "FreshRSS manual (English)".

Add missing H1s to two pages that were silently dropped from the sidebar:
the user FAQ and the Caddy reverse proxy page. The sidebar template uses
page.title (derived from H1 by jekyll-titles-from-headings), so pages
without an H1 had title=nil and were skipped.

Update sidebar parent labels in docs_nav.html and the chapter list in
en/index.md to use the new "* manual" naming. Update link text in section
indexes that referenced the old H1s. Bundle two grammar fixes encountered
along the way: "an User Interface" -> "a user interface", and drop the
awkward "the" in "Configuring the email address validation".

EN only. No filenames, URLs, or anchor targets changed (anchors come from
H2 and below, which are untouched). FR is generated from EN via po4a and
will be regenerated separately.

Co-authored-by: Bjørn A. Andersen <polybjorn@users.noreply.github.com>
2026-05-02 22:23:35 +02:00
Inverle
63c8fe1285 docs: Fix broken or dead links (#8548)
* docs: Fix broken or dead links
Used the following commands to find broken links:
1. `lychee -E --dump https://freshrss.github.io/FreshRSS/en/ --include freshrss.github.io --output links.txt`
2. `lychee -v --suggest --archive wayback --timeout 5 -u "Mozilla/5.0 (X11; Linux x86_64; rv:148.0) Gecko/20100101 Firefox/148.0" --files-from links.txt --output output.txt`
3. `cat output.txt`

Then did the same for https://freshrss.github.io/FreshRSS/fr/

We could look into using lychee in CI:
https://github.com/lycheeverse/lychee?tab=readme-ov-file#github-action-usage

* Replace PostgreSQL 16 link with current version

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>

* Remove paragraph about bug message format

* Update README with official app website links

* Replace broken French images with English versions

* Fix broken Fever API docs link in French docs

* Replace GNU Social link with new one in `shares.php`

---------

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2026-03-02 08:21:23 +01:00
Elanna Grossman
60b5459cac Update Reader Link Documentation (#7362)
* docs(docs): update Reeder link to point to Reeder Classic

* docs(CREDITS): add name to credits
2025-02-24 12:35:00 +01:00
Alexandre Alapetite
bf7a8bbdc5 API documentation link to more tips (#7305)
https://github.com/jocmp/capyreader/discussions/533#discussioncomment-11341808
While waiting for https://github.com/FreshRSS/FreshRSS/issues/7304
We should then consolidate the API synchronisation recommendations in our documentation
2025-02-06 23:14:20 +01:00
th0mcat
79bf7d4967 Add Read You (#4633)
* Add Read You

* Update README.fr.md

* Add Read You

* Add Read You

* Add Read You

* Add Read You

* Beta version ready
https://github.com/Ashinch/ReadYou/pull/536
https://github.com/Ashinch/ReadYou/discussions/478
https://github.com/Ashinch/ReadYou/discussions/542

---------

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2024-01-21 13:56:08 +01:00
Alexandre Alapetite
ac5980231b API add unsubscribe example (#5965) 2023-12-23 11:07:14 +01:00
Alexandre Alapetite
7e1f549eb4 Changelog 2023-11-25 12:44:52 +01:00
Alexandre Alapetite
5e71669589 GReader API doc and improvements (#4763)
* GReader API doc and improvements
#fix https://github.com/FreshRSS/FreshRSS/issues/4762

* Minor slash

* HTTPS for web.archive.org
2022-10-23 12:47:27 +02:00
Jan Lukas Gernert
500d2e4902 Update NewsFlash app entry (#4650)
* Update NewsFlash app entry

* update fr readme & remove FeedReader

* Tested

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2022-10-16 14:25:25 +02:00
Alexandre Alapetite
eb850b7a01 Add Fluent Reader Lite (#4595)
#fix https://github.com/FreshRSS/FreshRSS/issues/3418
2022-09-10 15:17:49 +02:00
Matt Sephton
23bf530639 lire app (#4523)
* Update README.md

Add lire, sort alphabetically

* Mix conflict

* English

* GReader

* Duplicate line Reeder

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2022-08-22 23:18:50 +02:00
Alexandre Alapetite
d27cf13248 News+ use GitHub links (#4262)
Google Play links do not work anymore
2022-03-06 21:32:00 +01:00
maTh
639f8eea84 Documentation improved: mobile access (#4235)
* Update 06_Mobile_access.md

* Readme: Windows + MacOS

* fix markdown

* Update docs/en/users/06_Mobile_access.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/06_Mobile_access.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* MacOS -> macOS

* Update 06_Mobile_access.md

* Update docs/en/users/06_Mobile_access.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
2022-02-27 21:50:28 +01:00
Alexandre Alapetite
1acd3ab09b Use typographic quotes (#4133)
* Use typographic quotes

* A few fixes

* Fix

* Fix not saved

* Implement feedback

* Detail

* Revert spoken English fixes
Left for a future dedicated discussion

* More reverts

* Final reverts

* Final minor
2022-01-08 21:58:55 +01:00
Alexandre Alapetite
acbba9adb2 Improved markdownlint (#3918)
* Improved markdownlint
* Relaxed rules slighlty
* `npm run markdownlint` for automatic tests
* `npm run markdownlint_fix` for automatic syntax fixing
* Applied the fixes on all our Markdown files
2021-10-23 13:43:24 +02:00
Felix Bühler
915dcc3ccc Split fever & greader into two separate pages. (#3905)
* [docs] add newsflash to fever-clients

* [docs] split fever&greader-apis into two pages and make the more consistent
2021-10-23 13:32:20 +02:00