[PR #59] [MERGED] Update documentation and configuration structures #79

New issue

Closed

opened 2026-03-14 12:30:56 +03:00 by kerem · 0 comments

kerem commented

2026-03-14 12:30:56 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/aome510/hackernews-TUI/pull/59
Author: @aome510
Created: 12/24/2021
Status: ✅ Merged
Merged: 12/29/2021
Merged by: @aome510

Base: main ← Head: add-theme-documentation

📝 Commits (10+)

f4e7ee1 use article_md --format html as the default article_parse_command
55ac21a use top/bottom padding of size 1
266d6c3 update README
1f1daf5 change default shortcuts for top and bottom to g and G
605bf22 remove client config option and client.story_limit config option
101c8db replace ArticleParseCommand with general Command struct
c7f55a7 add a draft configuration documentation
e52d5c9 clean up example configuration file
36d935a add config::Keymap::custom_keymaps
edac644 fix parsing error for the example config file

📊 Changes

20 files changed (+530 additions, -405 deletions)

View changed files

📝 README.md (+92 -134)
➕ config.md (+232 -0)
➖ examples/assets/article_view.png (+0 -0)
➖ examples/assets/comment_view.png (+0 -0)
➖ examples/assets/help_view.png (+0 -0)
➖ examples/assets/story_search_view.png (+0 -0)
➖ examples/assets/story_view.png (+0 -0)
📝 examples/hn-tui.toml (+137 -164)
📝 hackernews_tui/src/client/mod.rs (+10 -15)
📝 hackernews_tui/src/config/keybindings.rs (+7 -15)
📝 hackernews_tui/src/config/mod.rs (+18 -45)
📝 hackernews_tui/src/config/theme.rs (+1 -2)
📝 hackernews_tui/src/main.rs (+3 -2)
📝 hackernews_tui/src/utils.rs (+15 -8)
📝 hackernews_tui/src/view/article_view.rs (+1 -1)
📝 hackernews_tui/src/view/async_view.rs (+3 -4)
📝 hackernews_tui/src/view/help_view.rs (+6 -5)
📝 hackernews_tui/src/view/list_view.rs (+1 -1)
📝 hackernews_tui/src/view/search_view.rs (+2 -2)
📝 hackernews_tui/src/view/story_view.rs (+2 -7)

📄 Description

Brief description of changes

add new configuration documentation in config.md
add new examples to REAMDE
use tables to describe default command shortcuts in README

Breaking changes

change default shortcuts for top and bottom commands in ArticleView to g and G
remove client and client.story_limit config options (use hard-coded story/search limits), replace client.client_timeout by client_timeout
use config::Command struct to represent a command as a config option (used for url_open_command and article_parse_command)
use keymap.custom_keymaps to add custom story view navigation shortcuts instead of keymap.custom_keymap.custom_view_navigation
rename toggle_sort_by command in StoryView to toggle_sort_by_date

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/aome510/hackernews-TUI/pull/59 **Author:** [@aome510](https://github.com/aome510) **Created:** 12/24/2021 **Status:** ✅ Merged **Merged:** 12/29/2021 **Merged by:** [@aome510](https://github.com/aome510) **Base:** `main` ← **Head:** `add-theme-documentation` --- ### 📝 Commits (10+) - [`f4e7ee1`](https://github.com/aome510/hackernews-TUI/commit/f4e7ee1c87f755cc8da17ea2ca7c80c6231922cf) use `article_md --format html` as the default `article_parse_command` - [`55ac21a`](https://github.com/aome510/hackernews-TUI/commit/55ac21a5be70b5054ef7c8363968b689061b2e9d) use top/bottom padding of size 1 - [`266d6c3`](https://github.com/aome510/hackernews-TUI/commit/266d6c344e529402e5e3de82498467206534726f) update README - [`1f1daf5`](https://github.com/aome510/hackernews-TUI/commit/1f1daf567bc4a5fdbdc027c8054bb2b654d8d8d4) change default shortcuts for `top` and `bottom` to `g` and `G` - [`605bf22`](https://github.com/aome510/hackernews-TUI/commit/605bf22ea9ee4e7e15875dd5171ae8f50ae7534f) remove `client` config option and `client.story_limit` config option - [`101c8db`](https://github.com/aome510/hackernews-TUI/commit/101c8dba31fe2b02e167c842867cc75c16240737) replace `ArticleParseCommand` with general `Command` struct - [`c7f55a7`](https://github.com/aome510/hackernews-TUI/commit/c7f55a7efb95c9c37b66c932dcfe1824a078b816) add a draft configuration documentation - [`e52d5c9`](https://github.com/aome510/hackernews-TUI/commit/e52d5c934d26ed654b8dd98027131d62298d1942) clean up example configuration file - [`36d935a`](https://github.com/aome510/hackernews-TUI/commit/36d935a539a0ad74d86323ee5145de5111a8d85e) add `config::Keymap::custom_keymaps` - [`edac644`](https://github.com/aome510/hackernews-TUI/commit/edac644db3906e5931be7a78ca7955cd16164b71) fix parsing error for the example config file ### 📊 Changes **20 files changed** (+530 additions, -405 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+92 -134) ➕ `config.md` (+232 -0) ➖ `examples/assets/article_view.png` (+0 -0) ➖ `examples/assets/comment_view.png` (+0 -0) ➖ `examples/assets/help_view.png` (+0 -0) ➖ `examples/assets/story_search_view.png` (+0 -0) ➖ `examples/assets/story_view.png` (+0 -0) 📝 `examples/hn-tui.toml` (+137 -164) 📝 `hackernews_tui/src/client/mod.rs` (+10 -15) 📝 `hackernews_tui/src/config/keybindings.rs` (+7 -15) 📝 `hackernews_tui/src/config/mod.rs` (+18 -45) 📝 `hackernews_tui/src/config/theme.rs` (+1 -2) 📝 `hackernews_tui/src/main.rs` (+3 -2) 📝 `hackernews_tui/src/utils.rs` (+15 -8) 📝 `hackernews_tui/src/view/article_view.rs` (+1 -1) 📝 `hackernews_tui/src/view/async_view.rs` (+3 -4) 📝 `hackernews_tui/src/view/help_view.rs` (+6 -5) 📝 `hackernews_tui/src/view/list_view.rs` (+1 -1) 📝 `hackernews_tui/src/view/search_view.rs` (+2 -2) 📝 `hackernews_tui/src/view/story_view.rs` (+2 -7) </details> ### 📄 Description ## Brief description of changes - add new configuration documentation in `config.md` - add new examples to `REAMDE` - use tables to describe default command shortcuts in `README` ## Breaking changes - change default shortcuts for `top` and `bottom` commands in `ArticleView` to `g` and `G` - remove `client` and `client.story_limit` config options (use hard-coded story/search limits), replace `client.client_timeout` by `client_timeout` - use `config::Command` struct to represent a command as a config option (used for `url_open_command` and `article_parse_command`) - use `keymap.custom_keymaps` to add custom story view navigation shortcuts instead of `keymap.custom_keymap.custom_view_navigation` - rename `toggle_sort_by` command in `StoryView` to `toggle_sort_by_date` --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>