Update docs to: EditorAPI Refactor (#71)

Author: github-actions[bot]

docs/create_action_scripts.md

@@ -3,6 +3,21 @@
 !!! Note
     Reading [Action Scripts Guide](action_scripts.md) is recommended before creating actions scripts.
 
+## When I should use action scripts?
+
+There is a checklist before selecting action script as your solution:
+- I need add an action that user can trigger it?
+
+    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.
+- I need add a new option in menus?
+
+    If yes, It **must** be action script. Everything in menus is action script.
+- I need 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.
+
 ## Regular action scripts
 
 There is some different types of action scripts based on their base classes, `ActionScript` class designed for regular

docs/mode_development.md

@@ -0,0 +1,38 @@
+# Mode Development
+
+Text Forge have a powerful and feature rich API to add support for any language in the fastest way. We provide modes to
+help developers and users work with any file just with plug one module. In this page, we will show a standard way for
+mode development to you and best practices.
+
+!!! Note
+    
+    Reading [Modes Guide](modes.md) is highly recommended before develop modes, please read that document before this.
+
+## Text Forge Mode API
+
+To handle external modules we need an API, so we provide **Text Forge Mode API** (TFM API in short) as modes' connection
+way. TFM is a feature packed API for any mode, so it have a lot of features.
+
+!!! Note
+
+    We have multiple versions of TFM API, and each editor version just supports one TFM API version (but a TFM API 
+    version can be shared between a lot of versions). Latest TFM API version is 2.0 currently and this version supports
+    Text Forge 0.1-stable and newer versions.
+
+To use all features of modes, you should know about its API, so we will explain it a little more. TFM API consists of 
+two parts, the first part is in EditorAPI that connect editor to modes, the second part is the `TextForgeMode` class, 
+which keeps this connection standard and provides some ready-made features.
+
+You will work with **TextForgeMode** to complete your mode, this will define your mode and EditorAPI will do the rest.
+So a mode have a very important part, its script. This script extends TextForgeMode class and customizes behaviors to 
+provide your mode logic.
+
+## Make your first mode with template
+
+We provide a mode template to help mode developers, specially for first time testing. You can find it [here](https://github.com/text-forge/mode-template), 
+you can download, clone or fork it to have a simple initialization, you can find guides in template.
+
+## Useful examples
+
+You can see our official modes like [Web Mode Kit](https://github.com/text-forge/web-mode-kit) and 
+[GDScript Mode](https://github.com/text-forge/gdscript-mode) to find solutions for most important challenges.

docs/modes.md

@@ -1,25 +1,102 @@
 # Modes In Text Forge
 
 Text Forge is lightweight and language agnostic, So there is no default dependence on any language. But how you can work
-with any file type and have special features like syntax highlighter?
-This is where the mods come in, a mode is a special module designed to adapt to certain types of files and languages,
-you can enter the mods and leave the rest to the editor, everything is automatically managed to you can work with files.
+with any file type and have special features like syntax highlighters and linters?
+This is where the modes come in, a mode is a special module designed to adapt to certain types of files and languages,
+you can install the modes and leave the rest to the editor, everything is automatically managed to you can work with files.
 
-## Packages
+## Mode Features
+
+There is a list of all standard available features for modes, some mode can have more features with custom solutions and
+some modes can haven't one or more feature is this list. In short, you can find optional features with *optional* tag, 
+features of a mode depends on its developers:
+
+- **Save & Load**
+
+    Modes can encode and decode files, with this customizable encoding system you can work with a lot of files, even
+    with files they aren't text files!
+
+- **Syntax Highlighter** _optional_
+
+    We provide both simple and advanced syntax highlighting ability to mode developers, including simple highlighters to
+    fully customized highlighters. Highlighters currently can just one theme and highlighter colors are completely mode-driven.
+
+- **Advanced Commenting Handling** _optional_
+
+    We have easy API for defining comment delimiters and logics. Editor provides line folding and more based on these
+    information.
+
+- **Mode Panels** _optional_
+
+    Modes can have their panels, so you can configure a mode visually based on mode features.
+
+- **Auto Format** & **Auto Indent** _optional_
+
+    We provide auto format and auto indent options separately, you can run these options to clean your files with modes'
+    power. You can use these features from command palette, menus, or with shortcuts; These features are available in 
+    `Edit > Indention > Auto Indent` and `Format > Auto Format`, to see shortcuts, type `Auto Indent` or `Auto Format`
+    in command palette.
+
+- **Initialization Lifecycle**
+
+    We have high standards about your files safety, so a mode will load completely before working with your file, or if 
+    initialization fails, we will cancel task.
+
+- **Code Completion** _optional_
+
+    We provide a mode-based code completion to you with complete API for mode developers, so features and smartness of
+    this feature is based on your current mode.
+
+- **Preview Rendering** _optional_
+
+    Modes can generate live preview based on your file, and you can see this preview in **Preview Panel** in right side of editor.
+
+- **File Outline** _optional_
+
+    You can navigate between sections in your file or review them in **Outline Panel** in left side of editor, this is a
+    mode-driven feature too, so this section features are based on your mode.
+
+- **Linting** _optional_
+
+    We currently haven't supported LSP & DAP client ([feature tracking issue↗️](https://github.com/text-forge/text-forge/issues/88))
+    for complete language based features, but we have a simple mode-driven linting feature, and you can see your file
+    problems in **Problems Panel** in bottom of editor, in this panel all error and warnings provided by mode will show
+    , and you can navigate between them by clicking on an item.
+
+!!! Note
+
+    A lot of above features were added in TFM API v2.0, you can read more about this API [here](mode_development.md#text-forge-mode-api).
+    We provide a lot of these features as optional features, because a mode can work with simple text or non-code files,
+    so there is a lot of optional but basic features.
+
+!!! Note
+
+    After TFM API v2.0, we use buffer based save and load instead of file based behavior, this new system have safer 
+    error handling and modes can no longer see the file paths in your system directly when you save / load a file.
+
+!!! Important
+
+    Modes are unlimited moduless! So you should be sure about a mode before installing it, otherwise modes can get access
+    to your files content, for completely safe experience download official and community modes in [mode library](https://github.com/text-forge/mode-library).
+
+!!! Note
+
+    Auto Format and Auto Indent are triggerable actions, there is an **Auto Indention** toggleable feature in `Format`
+    menu that will change indention automatically when you create new line.
+
+## Mode Kits
 
 In programming word, there is a lot of types of programmers, for example you can be a web developer, in this case you 
-need to work with some files as your basic workflow, such as `.html`, `.css`, and `.js`. So we provide packages, a
-package is a collection from related modes create for a special type of users.
+need to work with some files as your basic workflow, such as `.html`, `.css`, and `.js`. So we provide mode kits, a
+mode kit is a collection from related modes create for a special type of users.
 
-## Installing Modes & Packages
+## Installing Modes & Mode Kits
 
-You can find modes and packages from official library or community created collections, there is some useful link about modes:
+You can find modes and mode kits in official library or community created collections, there is some useful link about modes:
 
 - [Currently Available Modes List](https://github.com/text-forge/mode-library#mode-support-status)
 - [Official Mode Library](https://github.com/text-forge/mode-library)
-- [Latest Modes Release](https://github.com/text-forge/mode-library/releases/latest)
-- [Official Packages](https://github.com/text-forge/mode-library/wiki/Packages)
 
-A mode or package is a `.zip` or `.tfmode` file, use **Mode Manager** (`Settings > Mode Manager` in menus) and select
-this file with `Import Mode / Package`. After loading, you will receive an **info** notification that says 
-`"Load mode / package completed"` and you can use your new modes now without restart editor.
+A mode or mode kit is a `.zip` or `.tfmode` file, use **Mode Manager** (`Settings > Mode Manager` in menus) and select
+this file with `Import Mode / Mode Kit`. After loading, you will receive an **info** notification that says 
+`"Load mode / mode kit completed"` and you can use your new modes now without restart editor.