update docs

docs/developers/AI.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) /  AI Description
-
 There are two types of AI: adventure and battle.
 
 **Adventure AIs** are responsible for moving heroes across the map and developing towns  

docs/developers/Bonus_System.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Bonus System
-
 The bonus system of VCMI is a set of mechanisms that make handling of different bonuses for heroes, towns, players and units easier. The system consists of a set of nodes representing objects that can be a source or a subject of a bonus and two directed acyclic graphs (DAGs) representing inheritance and propagation of bonuses. Core of bonus system is defined in HeroBonus.h file.
 
 ## Propagation and inheritance

docs/developers/Building_Android.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Building for Android
-
 The following instructions apply to **v1.2 and later**. For earlier versions the best documentation is https://github.com/vcmi/vcmi-android/blob/master/building.txt (and reading scripts in that repo), however very limited to no support will be provided from our side if you wish to go down that rabbit hole.
 
 *Note*: building has been tested only on Linux and macOS. It may or may not work on Windows out of the box.

docs/developers/Building_Linux.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Building on Linux
-
 # Compiling VCMI
 
 - Current baseline requirement for building is Ubuntu 20.04

docs/developers/Building_Windows.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Building on Windows
-
 # Preparations
 Windows builds can be made in more than one way and with more than one tool. This guide focuses on the simplest building process using Microsoft Visual Studio 2022
 

docs/developers/Building_iOS.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Building for iOS
-
 ## Requirements
 
 1. **macOS**

docs/developers/Building_macOS.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Building on macOS
-
 # Requirements
 
 1. C++ toolchain, either of:

docs/developers/Code_Structure.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Code Structure
-
 The code of VCMI is divided into several main parts: client, server, lib and AIs, each one in a separate binary file.
 
 # The big picture

docs/developers/Coding_Guidelines.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Coding Guidelines
-
 ## C++ Standard
 
 VCMI implementation bases on C++17 standard. Any feature is acceptable as long as it's will pass build on our CI, but there is list below on what is already being used.

docs/developers/Conan.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Using Conan
-
 # Using dependencies from Conan
 
 [Conan](https://conan.io/) is a package manager for C/C++. We provide prebuilt binary dependencies for some platforms that are used by our CI, but they can also be consumed by users to build VCMI. However, it's not required to use only the prebuilt binaries: you can build them from source as well.

docs/developers/Development_with_Qt_Creator.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Development with Qt Creator
-
 # Introduction to Qt Creator
 
 Qt Creator is the recommended IDE for VCMI development on Linux distributions, but it may be used on other operating systems as well. It has the following advantages compared to other IDEs:

docs/developers/Logging_API.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) /  Logging System
-
 # Features
 
 -   A logger belongs to a "domain", this enables us to change log level settings more selectively

docs/developers/Lua_Scripting_System.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Lua Scripting System
-
 # Configuration
 
 ``` javascript

docs/developers/Networking.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Networking
-
 # The big picture
 
 For implementation details see files located at `lib/network` directory.

docs/developers/Serialization.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Serialization System
-
 # Introduction
 
 The serializer translates between objects living in our code (like int or CGameState\*) and stream of bytes. Having objects represented as a stream of bytes is useful. Such bytes can send through the network connection (so client and server can communicate) or written to the disk (savegames).

docs/maintainers/Project_Infrastructure.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Project Infrastructure
-
 # Project Infrastructure
 
 This section hold important information about project infrastructure for current and future contributors. At moment it's all maintained by me (SXX), but following information will be useful if someone going to replace me in future.

docs/maintainers/Release_Process.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Release Process
-
 # Versioning
 For releases VCMI uses version numbering in form "1.X.Y", where:
 - 'X' indicates major release. Different major versions are generally not compatible with each other. Save format is different, network protocol is different, mod format likely different.

docs/maintainers/Ubuntu_PPA.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Ubuntu PPA
-
 ## Main links
 - [Team](https://launchpad.net/~vcmi)
 - [Project](https://launchpad.net/vcmi)

docs/modders/Animation_Format.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / [Modding](Readme.md) / Animation Format
-
 VCMI allows overriding HoMM3 .def files with .json replacement. Compared to .def this format allows:
 
 -   Overriding individual frames from json file (e.g. icons)

docs/modders/Bonus/Bonus_Duration_Types.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / [Bonus Format](../Bonus_Format.md) / Bonus Duration Types
-
 Bonus may have any of these durations. They acts in disjunction.
 
 ## List of all bonus duration types

docs/modders/Bonus/Bonus_Limiters.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / [Bonus Format](../Bonus_Format.md) / Bonus Limiters
-
 ## Predefined Limiters
 
 The limiters take no parameters:

docs/modders/Bonus/Bonus_Propagators.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / [Bonus Format](../Bonus_Format.md) / Bonus Propagators
-
 ## Available propagators
 
 -   BATTLE_WIDE: Affects both sides during battle

docs/modders/Bonus/Bonus_Range_Types.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / [Bonus Format](../Bonus_Format.md) / Bonus Range Types
-
 # List of all Bonus range types
 
 - NO_LIMIT

docs/modders/Bonus/Bonus_Sources.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / [Bonus Format](../Bonus_Format.md) / Bonus Sources
-
 # List of all possible bonus sources
 
 - ARTIFACT

docs/modders/Bonus/Bonus_Types.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / [Bonus Format](../Bonus_Format.md) / Bonus Types
-
 The bonuses were grouped according to their original purpose. The bonus system allows them to propagate freely betwen the nodes, however they may not be recognized properly beyond the scope of original use.
 
 # General-purpose bonuses

docs/modders/Bonus/Bonus_Updaters.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / [Bonus Format](../Bonus_Format.md) / Bonus Updaters
-
 TODO: this page may be incorrect or outdated
 
 # List of Bonus Updaters

docs/modders/Bonus/Bonus_Value_Types.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / [Bonus Format](../Bonus_Format.md) / Bonus Value Types
-
 Total value of Bonus is calculated using the following:
 
 -   For each bonus source type we calculate new source value (for all bonus value types except PERCENT_TO_SOURCE and PERCENT_TO_TARGET_TYPE) using the following:

docs/modders/Bonus_Format.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / [Modding](Readme.md) / Bonus Format
-
 ## Full format
 
 All parameters but type are optional.

docs/modders/Building_Bonuses.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / [Modding](Readme.md) / Building Bonuses
-
 Work-in-progress page do describe all bonuses provided by town buildings
 for future configuration.
 

docs/modders/Campaign_Format.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / [Modding](Readme.md) / Campaign Format
-
 # Introduction
 
 Starting from version 1.3, VCMI supports its own campaign format.

docs/modders/Configurable_Widgets.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / [Modding](Readme.md) / Configurable Widgets
-
 # Table of contents
 
 - [Introduction](#introduction)

docs/modders/Difficulty.md

@@ -1,6 +1,3 @@
-< [Documentation](../Readme.md) / [Modding](Readme.md) / Difficulty
-
-
 Since VCMI 1.4.0 there are more capabilities to configure difficulty parameters.
 It means, that modders can give different bonuses to AI or human players depending on selected difficulty
 

docs/modders/Entities_Format/Artifact_Format.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / Artifact Format
-
 Artifact bonuses use [Bonus Format](../Bonus_Format.md)
 
 ## Required data

docs/modders/Entities_Format/Battle_Obstacle_Format.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / Battle Obstacle Format
-
 ```jsonc
 	// List of terrains on which this obstacle can be used
 	"allowedTerrains" : []

docs/modders/Entities_Format/Battlefield_Format.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / Battlefield Format
-
 ```jsonc
 	// Human-readable name of the battlefield
 	"name" : ""

docs/modders/Entities_Format/Creature_Format.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / Creature Format
-
 ## Required data
 
 In order to make functional creature you also need:

docs/modders/Entities_Format/Faction_Format.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / Faction Format
-
 ## Required data
 
 In order to make functional town you also need:

docs/modders/Entities_Format/Hero_Class_Format.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / Hero Class Format
-
 ## Required data
 
 In order to make functional hero class you also need:

docs/modders/Entities_Format/Hero_Type_Format.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / Hero Type Format
-
 ## Required data
 
 In order to make functional hero you also need:

docs/modders/Entities_Format/River_Format.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / River Format
-
 ## Format
 
 ```jsonc

docs/modders/Entities_Format/Road_Format.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / Road Format
-
 ## Format
 
 ```jsonc

docs/modders/Entities_Format/Secondary_Skill_Format.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / Secondary Skill Format
-
 ## Main format
 
 ```jsonc

docs/modders/Entities_Format/Spell_Format.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / Spell Format
-
 # Main format
 
 ``` javascript

docs/modders/Entities_Format/Terrain_Format.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / Terrain Format
-
 ## Format
 
 ```jsonc

docs/modders/Game_Identifiers.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / [Modding](Readme.md) / Game Identifiers
-
 ## List of all game identifiers
 
 This is a list of all game identifiers available to modders. Note that only identifiers from base game have been included. For identifiers from mods please look up corresponding mod

docs/modders/Map_Editor.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / [Modding](Readme.md) / Map Editor
-
 # Interface
 
 <img width="738" src="https://user-images.githubusercontent.com/9308612/188775648-8551107d-9f0b-4743-8980-56c2c1c58bbc.png">

docs/modders/Map_Object_Format.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / [Modding](Readme.md) / Map Object Format
-
 ## Description
 
 Full object consists from 3 parts:

docs/modders/Map_Objects/Boat.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / [Map Object Format](../Map_Object_Format.md) / Boat
-
 ``` javascript
 {
 	// Layer on which this boat moves. Possible values:

docs/modders/Map_Objects/Creature_Bank.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / [Map Object Format](../Map_Object_Format.md) / Creature Bank
-
 Reward types for clearing creature bank are limited to resources, creatures, artifacts and spell.
 Format of rewards is same as in [Rewardable Objects](Rewardable.md)
 

docs/modders/Map_Objects/Dwelling.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / [Map Object Format](../Map_Object_Format.md) / Dwelling
-
 ``` javascript
 {
 	/// List of creatures in this bank. Each list represents one "level" of bank

docs/modders/Map_Objects/Market.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / [Map Object Format](../Map_Object_Format.md) / Market
-
 # Market schema
 
 Since VCMI-1.3 it's possible to create customizable markets on adventure map.

docs/modders/Map_Objects/Rewardable.md

@@ -1,5 +1,3 @@
-< [Documentation](../../Readme.md) / [Modding](../Readme.md) / [Map Object Format](../Map_Object_Format.md) / Rewardable
-
 ## Table of Contents
 - [Base object definition](#base-object-definition)
 - [Configurable object definition](#configurable-object-definition)

docs/modders/Mod_File_Format.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / [Modding](Readme.md) / Mod File Format
-
 ## Fields with description of mod
 
 ``` javascript

docs/modders/Random_Map_Template.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / [Modding](Readme.md) / Random Map Template Format
-
 ## Template format
 
 ``` javascript

docs/modders/Readme.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Modding
-
 # Creating mod
 
 To make your own mod you need to create subdirectory in **<data dir>/Mods/** with name that will be used as identifier for your mod.

docs/modders/Translations.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / [Modding](Readme.md) / Translations
-
 # Translation system
 
 ## List of currently supported languages
@@ -24,6 +22,12 @@ This is list of all languages that are currently supported by VCMI. If your lang
 - Ukrainian
 - Vietnamese
 
+## Progress of the translations
+You can see the current progress of the different translations here:
+[Translation progress](https://github.com/vcmi/vcmi-translation-status)
+
+The page will be automatically updated once a week.
+
 ## Translating Heroes III data
 
 VCMI allows translating game data into languages other than English. In order to translate Heroes III in your language easiest approach is to:

docs/players/Bug_Reporting_Guidelines.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Bug Reporting Guidelines
-
 First of all, thanks for your support! If you report a bug we can fix it. But keep in mind that reporting your bugs appropriately makes our (developers') lifes easier. Here are a few guidelines that will help you write good bug reports.
 
 # Github bugtracker

docs/players/Cheat_Codes.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Cheat Codes
-
 # Cheat Codes
 
 Similar to H3, VCMI provides cheat codes to make testing game more convenient.

docs/players/Game_Mechanics.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Game Mechanics
-
 # List of features added in VCMI
 
 ## High resolutions

docs/players/Installation_Android.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Installation on Android
-
 ## Step 1: Download and install VCMI
 
 **This app requires original heroes 3 sod / complete files to operate, they are not supplied with this installer. it is recommended to purchase version from gog.com. Heroes 3 "hd edition" (steam version) files are not supported !!!**  

docs/players/Installation_Linux.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Installation on Linux
-
 VCMI requires data from original Heroes 3: Shadow of Death or Complete editions. Data from native Linux version made by LOKI will not work.
 
 # Step 1: Binaries installation

docs/players/Installation_Windows.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Installation on Windows
-
 # Prerequisites
 
 As of VCMI 1.2 and newer Windows 10 or newer is required since our automated system uses elements incompatible with older Windows.

docs/players/Installation_iOS.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Installation on iOS
-
 You can run VCMI on iOS 12.0 and later, all devices are supported. If you wish to run on iOS 10 or 11, you should build from source, see [How to build VCMI (iOS)](../developers/Building_iOS.md).
 
 ## Step 1: Download and install VCMI

docs/players/Installation_macOS.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Installation on macOS
-
 **For iOS installation look here: (Installation on iOS)[Installation_iOS.md]
 
 # Step 1: Download and install VCMI

docs/players/Privacy_Policy.md

@@ -1,5 +1,3 @@
-< [Documentation](../Readme.md) / Privacy Policy
-
 **Last Updated: 24th December, 2022**
 
 ### Glossary