Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history 
Signed-off-by: Benjamin Brahmer <[email protected]>
  • Loading branch information
@Grotax
Grotax committed Dec 23, 2024
1 parent c2a4d78 commit d115ee0
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 7 deletions.
9 changes: 2 additions & 7 deletions docs/admin.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,11 +63,6 @@ The update interval is used to determine when the next update of all feeds shoul
By default, the value is set to 3600 seconds (1 hour) You can configure this interval as an administrator.
The new value is only applied after the next run of the updater.

#### What is a good update interval?
Since News 25.2.0 news no longer will update all feeds instaed it will make a induvidual decision based on when an update for the feed will make sense. Thefore this intervall is now only to be understood as the check if an update should be done.

Check warning on line 66 in docs/admin.md

View workflow job for this annotation

GitHub Actions / typos 

"instaed" should be "instead".

Check warning on line 66 in docs/admin.md

View workflow job for this annotation

GitHub Actions / typos 

"Thefore" should be "Therefore".

Check warning on line 66 in docs/admin.md

View workflow job for this annotation

GitHub Actions / typos 

"intervall" should be "interval".

Check failure on line 66 in docs/admin.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'instaed'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'instaed'?", "location": {"path": "docs/admin.md", "range": {"start": {"line": 66, "column": 56}}}, "severity": "ERROR"}

Check failure on line 66 in docs/admin.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'induvidual'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'induvidual'?", "location": {"path": "docs/admin.md", "range": {"start": {"line": 66, "column": 79}}}, "severity": "ERROR"}

Check failure on line 66 in docs/admin.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Thefore'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Thefore'?", "location": {"path": "docs/admin.md", "range": {"start": {"line": 66, "column": 153}}}, "severity": "ERROR"}

Check failure on line 66 in docs/admin.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'intervall'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'intervall'?", "location": {"path": "docs/admin.md", "range": {"start": {"line": 66, "column": 166}}}, "severity": "ERROR"}

That depends on your individual needs.
Please keep in mind that the lower you set your update interval, the more traffic is generated.

#### Can I set individual update intervals per feed/user?

No, that is not possible.
Some feeds might not provide enough information to calculate the next update time those will be updated based on the update interval.
14 changes: 14 additions & 0 deletions docs/user.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# User

Welcome to the User documentaion of News.

Check warning on line 3 in docs/user.md

View workflow job for this annotation

GitHub Actions / typos 

"documentaion" should be "documentation".

Check failure on line 3 in docs/user.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'documentaion'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'documentaion'?", "location": {"path": "docs/user.md", "range": {"start": {"line": 3, "column": 21}}}, "severity": "ERROR"}

# TODO
This documentation is work in progress

# User interface

explain the different options in the UI especially options for feeds and settings

# Using News with Clients

explain sync and link to clients page

0 comments on commit d115ee0

Please sign in to comment.