Skip to content

Commit

Permalink
update docs (#83)
Browse files Browse the repository at this point in the history
  • Loading branch information
versun authored Jun 12, 2024
1 parent 4a8ff32 commit 14b2024
Show file tree
Hide file tree
Showing 10 changed files with 15 additions and 9 deletions.
Binary file modified website/docs/assets/action.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/docs/assets/add_translator_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/docs/assets/core_feeds.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/docs/assets/feeds_list_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/docs/assets/translated_feed_status.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/docs/assets/translator_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion website/docs/en/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ If you deployed on other way, wait for 5 minutes and still can't solve the probl

## Error: CSRF Authentication Failure

If you get a 403 CSRF authentication failure error after logging in, you need to set the environment variable CSRF_TRUSTED_ORIGINS to the domain name or IP address:https://*.example.com
If you get a 403 CSRF authentication failure error after logging in, you need to set the environment variable CSRF_TRUSTED_ORIGINS to the domain name or IP address:https://example.com:port,http://example.com:port

### IPv6

Expand Down
9 changes: 6 additions & 3 deletions website/docs/en/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ Check that it is valid, if it is not, you need to check the information you have
Click the +Add button in Original Feeds on the left.
![core_feeds](/assets/core_feeds.png)
Enter the relevant information
![add_feed](/assets/add_feed.png)
Save and jump to the list of feeds
![feed_list](/assets/feeds_list_2.png)
You need to make sure that the added feed is valid, then click on the name to go to the detail page
Expand All @@ -37,15 +36,19 @@ If you just translate the title and use the paid translation engine, it will tak

If translated content is ticked, it will take longer in order to maintain the translated format.

## Force update/delete/export sources
## Actions
Tick the source you want to operate, click Action, select the corresponding option, and click Go.
![action](/assets/action.png)

## Unified Subscription Link
## Combine Subscription Link
Use the following link to merge all translation sources into one source:

`http://127.0.0.1:8000/rss/all/t`.

It is also possible to subscribe to a category of sources individually:

`http://127.0.0.1:8000/rss/category/mycategory-1`

The merge is done in real time when you visit this URL, it is relatively resource intensive and the page is cached for 15 minutes.

## Viewing the service log
Expand Down
2 changes: 1 addition & 1 deletion website/docs/zh/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

## 报错:CSRF验证失败

如果在登录后出现403 CSRF验证失败的错误,则需要设置环境变量CSRF_TRUSTED_ORIGINS,值为域名或IP地址:https://*.example.com
如果在登录后出现403 CSRF验证失败的错误,则需要设置环境变量CSRF_TRUSTED_ORIGINS,值为域名或IP地址:https://example.com:port,http://example.com:port

### IPv6
目前无法同时支持IPv4和IPv6;
Expand Down
11 changes: 7 additions & 4 deletions website/docs/zh/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,9 @@
![translator_list](/assets/translator_list.png)

## 添加源
点击左侧Original Feeds的 +增加 按钮
点击左侧原始源的 +增加 按钮
![core_feeds](/assets/core_feeds.png)
输入相关信息
![add_feed](/assets/add_feed.png)
保存后会跳转到源列表
![feed_list](/assets/feeds_list_2.png)
需要确保添加的源是有效的(Valid),然后点击名称进入详情页
Expand All @@ -37,15 +36,19 @@

如果勾选了翻译内容,为了保持翻译后的格式,将会耗时较长时间。

## 强制更新/删除/导出源
## 动作
勾选需要操作的源,点击Action,选择对应选项,点击执行(Go)即可
![action](/assets/action.png)

## 统一订阅链接
## 合并订阅链接
使用以下链接可将所有翻译源合并为一个源:

`http://127.0.0.1:8000/rss/all/t`

也可以单独订阅某个类别的源:

`http://127.0.0.1:8000/rss/category/mycategory-1`

访问该网址后会实时进行合并,相对耗费资源,页面会缓存15分钟。

## 查看服务日志
Expand Down

0 comments on commit 14b2024

Please sign in to comment.