Commit Graph

13 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
maTh
ce11150bbd docs: headlines added (#7075)
* Update contributing.md

* Update 02_First_steps.md

* Update docs/en/contributing.md

---------

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2024-12-08 16:21:42 +01:00
Alexandre Alapetite
44a7c54a5a Update WebSub documentation a bit (#5829)
* Update WebSub documentation a bit

* Marien prefers not to promote his hub too much :-)
2023-11-08 20:24:24 +01:00
Steve Jones
8f188b57ee [docs] Fix typos on the word 'scrape' and its variations (#5567)
* Fix typos on the word 'scrape' and its variations

* Fix spelling of 'Tipps'
2023-08-05 13:54:09 +02:00
maTh
2f48509678 docs: web scrapping with XPath (#5494)
* added docs

* add correct link

* typo

* A bit of typography

---------

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2023-06-26 23:28:24 +02:00
maTh
e67ca8c866 documentation improved: split en/users/03_Main_view.md into 3 parts (#5013)
* documentation

* update the links

* fix
2023-01-17 15:36:43 +01:00
Alexandre Alapetite
e1f2ba85b1 Fix doc anchor (#4376)
* Fix doc anchor
The "search an article" link lead to a dead anchor
https://freshrss.github.io/FreshRSS/en/users/02_First_steps.html

* Fix wording
2022-05-19 21:31:44 +02: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
happymacarts
f0ca1288d2 Update 02_First_steps.md (#4049)
spelling correction of "available"
2021-12-10 11:48:50 +01:00
Frans de Jonge
705318aa39 Translate docs with po4a (#2590)
* [i18n] Add docs po4a script

* Add proof of concept

* Add a few more translations

* Hush ShellCheck and shfmt

* Make that list po4a-friendly

* drat, this document could've probably been auto-generated

* Definitive proof that it's translated from French ;-)

* Add some brand spanking new French translation

* More translation

* Mostly finish that config page

* Fix up FAQ

* More contributing

* Dev first steps

* Let's ignore that admin stuff at the very least for now

* Translate release new version, make French the source first and copy all translations

Then replace French with English in the source.

Much quicker than any alternative route.

* And add the English translation

* Minor stylistic leftover from French

* Most of first steps

* Forgot the extensions

* Use po4a 0.56 to get rid of way too many newlines

* Fix up those newlines

* No point linking to Firefox integration anymore from the new user guide

* Start on main view

* A bunch of main view stuff

* More main view

* And some subscriptions before going to bed

* First steps for devs

* More dev first steps

* Incomplete French → English dev/GH translation

Because I need to ask about that mailing list thing

* Fix typo in docs/en/developers/02_Github.md

* Translate & complete devs/github to English

* Fix up most of extensions

* Is that supposed to be a non-breaking space? Let's see

* Match up some users/mobile access

* More users/mobile access

* Add fresh French translation to Fever API

* Fix typo

* Match frontend todo thingies

* Fix a typo

* Some extensions strings

* Remove Fx subscription service from the docs

Cf. https://github.com/FreshRSS/FreshRSS/pull/2606

* Add translation for https://github.com/FreshRSS/FreshRSS/pull/2643

* fix typo as per https://github.com/FreshRSS/FreshRSS/pull/2643#discussion_r345433009

* Add some more French translations

* Update French translation as per @aledeg comment https://github.com/FreshRSS/FreshRSS/pull/2590#discussion_r345465909

* Translate some of the meaningless stuff

* Translate the rest of contributing.md to French

* Fix conflicts

* Translate Docker first steps to French

* Update with change from #2665

* Add @aledeg corrections

* Overlooked a couple @aledeg corrections thanks to GitHub autohide

* Latest @aledeg suggestions
2019-12-03 22:37:40 +01:00
Ryan Nielson
b2c77d1cb4 Fix link to installation instructions on first steps (#2665) 2019-11-14 15:22:48 +01:00
Kevin Papst
b562639155 Documentation updates (#1697)
* added documentation about updating FreshRSS
moved Installation to admin directory
linked some already existing documentation files
2017-12-02 13:43:28 +01:00
Marien Fressinaud
afc38e43ec Provide documentation under ./docs 2017-04-24 23:08:43 +02:00