Update docs to: #182: Add Notification Manager ( autoload) (@mkh-user)

Author: github-actions[bot]

docs/action_scripts.md

@@ -1,55 +1,42 @@
 # Action Scripts in Text Forge
 
-Action Scripts are a way to separate and manage possible actions in the Text Forge, helping them keep dozens of 
-different capabilities separately and safely and add new capabilities in the shortest time.
+Action Scripts are a way to separate and manage possible actions in the Text Forge, helping them keep dozens of different capabilities separately and safely and add new capabilities in the shortest time.
 
 ## Design goals
 
-- Modularity: Each action script is an independent unit with a specified output and input, almost all Action Scripts are
-  detachable from the editor without making an error in its performance
+- Modularity: Each action script is an independent unit with a specified output and input, almost all Action Scripts are detachable from the editor without making an error in its performance
 - Development: Developers can design new capabilities through simple Action Script APIs 
-- Accessibility: Action Scripts are easily accessible through code, command palette, and shortcuts
+- Accessibility: Action Scripts are easily accessible through menus, code, command palette, and shortcuts
 
 ## Structure
 
-An action script must extend `ActionScript` or `MultiActionScript` class or another class that extends one of these 
-classes. Each action script should be stored in `action_scripts/` directory and have snake_case file name of an option 
-english name in menus. For example if we have a `Save As...` option in `File` menu, editor will load `action_scripts/save_as.gd`
-as its action script (will remove dots) and otherwise this action script will not be loaded.
+An action script must extend `ActionScript` or `MultiActionScript` class or another class that extends one of these classes. Each action script should be stored in `action_scripts/` directory and have snake_case file name of an option english name in menus. For example if we have a `Save As...` option in `File` menu, editor will load `action_scripts/save_as.gd` as its action script (will remove dots) and otherwise this action script will not be loaded.
 
-Also, action scripts can have a shortcut in `shortcuts/` directory with same name. This file should be a `Shortcut` 
-resource (`.tres` file) with a `InputEventKey` as shortcut. Loading shortcut will be done by `ActionScript` class.
+Also, action scripts can have a shortcut in `data/shortcuts.tres` resource file with same name as key. Value should be a `InputEventKey` resource. Loading shortcut will be done by `ShortcutMap` and `ActionScript` class.
 
-All loaded action script will be children nodes of `Scripts` node in core, you can use `Global.get_scripts_node()` to 
-access to it.
+All loaded action script will be children nodes of `Scripts` node in core, you can use `Global.get_scripts_node()` to access to it.
 
-Each action script should override base class `Virtual` functions, you can see them in docstrings. There is a list of 
-virtual functions of regular `ActionScript`:
+Each action script should override base class `Virtual` functions, you can see them in docstrings. There is a list of virtual functions of regular `ActionScript`:
 - `_initialize()`: For action script initializing
 - `_run_action()`: Main part of action script
 
 ## Features
 
 ### Access to menu option
 
-Each action script have an item in menus, this item is accessible with `menu` and `index` property of action script.
-For checkbox and radio-checkbox options, editor will handle checking state itself.
+Each action script have an item in menus, this item is accessible with `menu` and `index` property of action script. For checkbox and radio-checkbox options, editor will handle checking state itself.
 
 ### Automated shortcut loading
 
-`ActionScript` and `MultiActionScript` class will load shortcuts from `shortcuts/` directory and call required functions
-in shortcut pressing.
+`ActionScript` and `MultiActionScript` class will load shortcuts from `data/shortcuts.tres` resource and call required functions in shortcut pressing.
 
 ### Define commands
 
-An action script will define itself as a command for command palette, so command palettes can list action scripts for
-user and run them based on selections. If an action script has shortcut, it will add that shortcut in commands database 
-so users can see shortcuts in command palette.
+An action script will define itself as a command for command palette, so command palettes can list action scripts for user and run them based on selections. If an action script has shortcut, it will add that shortcut in commands database so users can see shortcuts in command palette.
 
 ### Automated enabling / disabling
 
-`requires_file` and `requires_saved_file` properties can be used to make smarter action scripts, must action scripts
-just available when there is an opened file, so `requires_file == true` can disable them other times.
+The `requires_file` and `requires_saved_file` properties can make action scripts smarter. Most action scripts should only be available when a file is open, so setting `requires_file = true` disables them otherwise automatically.
 
 ## Create new action scripts
 

docs/build.md

@@ -2,9 +2,7 @@
 
 !!! Note
 
-    This page currently haven't complete guide for build, there is just manual for open project source in Godot.
-    To build editor from source use [this guide](https://docs.godotengine.org/en/stable/tutorials/export/exporting_projects.html)
-    from official Godot docs.
+    This page currently haven't complete guide for build, there is just manual for open project source in Godot.     To build editor from source use [this guide](https://docs.godotengine.org/en/stable/tutorials/export/exporting_projects.html) from official Godot docs.
 
 ## Get Engine
 

docs/contributing.md

@@ -62,13 +62,12 @@ Before opening an issue or submitting a pull request:
 ```
 addons/                 Third-party or custom Godot plugins  
 assets/                 Assets like images, fonts, icons  
-data/                   Config files and static data (e.g. menus)
-modes/                  Standalone editing modes (e.g. HTML Mode) 
+data/                   Config files and static data (e.g. menus, shortcuts) 
 docs/                   Project documentation and external guides  
 core/                   Main application structure and base nodes  
 action_scripts/         Action scripts and command logic  
-action_scripts/scenes/  Scenes and assets tied to action scripts  
-shortcuts/              Keybinding definitions for action scripts  
+action_scripts/scenes/  Scenes and assets tied to action scripts
+tests/                  Tests to track regressions and metrics
 ```
 
 ---

docs/create_action_scripts.md

@@ -7,42 +7,33 @@
 
 There is a checklist before selecting action script as your solution:
 
-- I need add an action that user can trigger it?
+- I need to add an action that a user can trigger?
 
-    If yes, It **can** be action script. Users can use menus, shortcuts, and commands to trigger action scripts. You can
-    use other ways to add triggerable actions, but action scripts are a standard way, specially for a lot of actions.
+    If yes, it **can** be an action script. Users can trigger action scripts via menus, shortcuts, and commands. You can add triggerable actions in other ways, but action scripts are the standard approach for many actions.
 
-- I need add a new option in menus?
+- I need to add a new option in menus?
 
-    If yes, It **must** be action script. Everything in menus is action script.
+    If yes, it **must** be an action script. Everything in menus is implemented via an action script.
 
-- I need add a new command?
+- I need to add a new command?
 
-    If yes, It **may** be action script. Action scripts have internal command defining system, and you can use them from
-    command palette, but you can define commands from everywhere in Text Forge, in modes, panels, extensions, action scripts, etc.
+    If yes, it **may** be an action script. Action scripts have an internal command-definition system, and you can use them from the command palette, but commands can also be defined in modes, panels, extensions, action scripts, and other parts of Text Forge.
 
 ## Regular action scripts
 
-There is some different types of action scripts based on their base classes, `ActionScript` class designed for regular
-action scripts and can handle a lot of tasks.
+There are different types of action scripts based on their base classes. The `ActionScript` class is designed for regular action scripts and can handle many tasks.
 
-To add new action script you should make sure there is an item in menus for that action script, you can use `data/main_ui.ini`
-to add new options (or menus), to understand about structure of this file you can see [here](https://text-forge.github.io/docs/data_driven_ui/#menus).
-After select your option create a script in `action_scripts/` directory with same name (but in snake_case), it this case
-we will create **Copy Path** action script that will copy file path of opened file in clipboard, so we will create
-`action_scripts/copy_path.gd` and use this script as start point:
+To add a new action script, first ensure there is a matching menu item. You can add options (or menus) in `data/main_ui.ini`; see the [Data-driven UI menu structure](https://text-forge.github.io/docs/data_driven_ui/#menus). After selecting your option, create a script in the `action_scripts/` directory with the same name in snake_case. In this example, we will create a **Copy Path** action script to copy the currently opened file path to the clipboard, so we create `action_scripts/copy_path.gd` and start with:
 
 ```gdscript
 extends ActionScript
 ```
 
-Just that! Run project and see option is enabled. But there is no action for now, so we have 3 steps to complete our 
-action script:
+That’s it for setup. Run the project and confirm the option is enabled. There is no behavior yet, so complete these three steps:
 
 ### Add initializing
 
-We needn't any special initializing for this action script, all we need is disabling it when there is no opened file, 
-there is ready-made feature for this:
+We don't need special initialization for this action script. We only need to disable when no file exists or when the file hasn’t been saved yet; `ActionScript` already provides this:
 
 ```gdscript
 extends ActionScript
@@ -52,15 +43,11 @@ func _initialize() -> void:
     requires_saved_file = true
 ```
 
-With this function `ActionScript` class will disable option when there isn't saved file, it means when you create a new
-file this option will keep disabled until that file saved, because before that there is no file path. Otherwise, (for 
-example when user uses Open) option will be enabled.
+With this function, `ActionScript` disables the option when no saved file exists. For example, after creating a new file, the option stays disabled until the file is saved (because no file path exists yet). When opening an existing file, the option is enabled.
 
 ### Add main action
 
-We have initialized action script, but there is no action, so let's add it. To do this we use `_run_action()` function,
-this function will be called when user clicks in option in menus, presses shortcut (we will add shortcut later) or uses
-command palette. So we can complete our action script with this function:
+We have initialized the action script, but it still has no behavior, so let’s add it. We do this with `_run_action()`, which runs when the user clicks the menu option, presses the shortcut (added later), or uses the command palette.
 
 ```gdscript
 extends ActionScript
@@ -73,13 +60,8 @@ func _run_action() -> void:
 	DisplayServer.clipboard_set(Global.get_file_path())
 ```
 
-Almost done! We have completed action script, and you can try it now in witch way you want.
+Almost done! The action script logic is complete, and you can try it now. Next, we'll add a shortcut.
 
 ### Add shortcut
 
-There is an easy way for adding shortcuts to action scripts, so let's see how we can do it. To have shortcut we need a
-`Shortcut` resource stored in `shortcuts/` directory, so go to Godot's FileSystem dock and use RMB on `res://shortcuts/`,
-then click on Create New > Resource... and create a `Shortcut` resource and save it as `copy_path.tres`. Shortcut will
-be opened in Inspector, click on `Events` and add new element, then create a new `InputEventKey` in that element. Use 
-`Configure` button and set your shortcut, then run project and try it. You can open command palette (Ctrl+P) and type `copy path`
-to see shortcut.
+To add a shortcut, open `data/shortcuts.tres` from Godot’s FileSystem dock and add a new `String: InputEventKey` pair (for example, key `copy_path`). Click **Configure** to set the keybinding, run the project, then open the command palette (`Ctrl+P`) and type `copy path` to confirm the shortcut appears.

docs/data_driven_ui.md

@@ -1,15 +1,12 @@
 # Explanation about Text Forge "Data Driven UI"
 
-Text Forge uses a data driven system for important parts UI, including menu options and texts. This architecture make
-a dynamic UI and clean translation system.
+Text Forge uses a data-driven system for important parts of the UI, including menu options and texts. This architecture makes a dynamic UI and a clean translation system.
 
 ## Menus
 
-All data related to menus stored in `data/main_ui.ini`, this file have a section for menus and a key for each menu (or 
-submenu). Each item is an array of dictionaries and each dictionary has the following structure:
+All data related to menus is stored in `data/main_ui.ini`. This file has a section for menus and a key for each menu (or submenu). Each item is an array of dictionaries and each dictionary has the following structure:
 
-- `"code"` - a unique integer for connect this option to its action script, its value can be any non-negative int bug must
-  be unique.
+- `"code"` - a unique integer used to connect this option to its action script; its value can be any non-negative int but must be unique.
 - `"text"` - english text of option, it will be used for add name to action scripts and call them based on names.
 - `"key"` - linked translation key in translation file, menu loader will use it to set item text.
 - `"type"` - an integer related to option type, this key can have these values:
@@ -19,12 +16,4 @@ submenu). Each item is an array of dictionaries and each dictionary has the foll
   - `2` - Checkbox
   - `3` - Radio Checkbox
 
-Each key must have `_menu` or `_submenu` suffix, items with `_menu` suffix will load in main menu and items with `_submenu`
-suffix will load as submenus based on texts, for example `Convert Case` submenu in `Edit` menu will load from `convert_case_submenu`
-key (snake case of submenu text with suffix).
-
-## Panels
-
-To handle panels, we have `data/panels/` folder. Here, each panel have a folder with icon, configuration file, and scene.
-In config file, we have place of panel (`R`, `L`, or `B`). Panel manager will load panels from here based on configuration
-file and stored files.
+Each key must have a `_menu` or `_submenu` suffix. Items with the `_menu` suffix will load in the main menu, and items with the `_submenu` suffix will load as submenus based on their texts. For example, the `Convert Case` submenu in the `Edit` menu will load from the `convert_case_submenu` key (snake case of submenu text with suffix).

docs/index.md

@@ -1,10 +1,8 @@
 # Text Forge Documentation
 
-Welcome to the official documentation of **Text Forge** — a modular, extensible, and language-agnostic text editor 
-built with user empowerment at its core.
+Welcome to the official documentation of **Text Forge** — a modular, extensible, and language-agnostic text editor built with user empowerment at its core.
 
-Whether you're a developer, programmer, or data manager, Text Forge gives you the tools to shape your editing experience 
-exactly the way you want.
+Whether you're a developer, programmer, or data manager, Text Forge gives you the tools to shape your editing experience exactly the way you want.
 
 ---
 
@@ -47,8 +45,7 @@ New to Text Forge? Start here: [Introduction to Text Forge](introduction.md)
 
 ## 🛠️ Contribute
 
-Text Forge is open source and community-driven. Join us on [GitHub](https://github.com/text-forge/text-forge), share 
-your ideas, and help shape the future of the editor.
+Text Forge is open source and community-driven. Join us on [GitHub](https://github.com/text-forge/text-forge), share your ideas, and help shape the future of the editor.
 
 Note that here is for documentations, so if you want to contribute in main project, please see [here](https://github.com/text-forge/text-forge)