docs: updated documentation and fixed some typos

docs/administration.md

@@ -42,6 +42,9 @@ with setting this option.
 A user without any permission in the admin section can still get read access to categories and records. You can set
 the permissions on categories and records in the category and record administration frontend.
 
+If you enable LDAP or Microsoft Entra ID authentication, you can't edit the user's profile in the admin area.
+The users will be created automatically when they log in the first time.
+
 ### 5.1.2 Group Administration
 
 phpMyFAQ also offers flexible management of privileges (or rights) for different groups in the admin area. You can set
@@ -182,46 +185,47 @@ edit and delete glossary items here. The items will be automatically displayed i
 
 ### 5.2.7 News Administration
 
-phpMyFAQ offers the ability to post news on the starting page of your FAQ. In the administration area you can create
-new news, edit existing news or delete them.
+phpMyFAQ offers the ability to post news on the starting page of your FAQ.
+In the administration area, you can create new news, edit existing news or delete them.
 
 ### 5.2.8 Attachment Administration
 
-In the attachment administration, you can see an overview of all all attachments with their filename, file size,
+In the attachment administration, you can see an overview of all attachments with their filename, file size,
 language and MIME type. You can delete them, too.
 
 ### 5.2.9 Tags Administration
 
-You can edit existing tags, of if you need to, you can delete the tag.
+You can edit existing tags, and if you need to, you can delete the tag.
 
 ## 5.3 Statistics
 
 ### 5.3.1 Ratings
 
-Below every FAQ, a visitor has the chance to rate the overall quality of a FAQ by giving ratings from 1 to 5 (whereas
-1 is the worst, 5 the best rating). In the statistics, the average rating and number of votes becomes visible for every
-rated FAQ. To give you a quick overview, FAQs with an average rating of 2 or worse are displayed in red, an average
+Below every FAQ, a visitor has the chance to rate the overall quality of a FAQ by giving ratings from one to five
+(whereas 1 is the worst, 5 the best rating).
+In the statistics, the average rating and number of votes becomes visible for every rated FAQ.
+To give you a quick overview, FAQs with an average rating of two or worse are displayed in red, an average
 above 4 results in a green number.
 
 ### 5.3.2 View sessions
 
 This function lets you keep track of your visitors. Every visitor is assigned an ID when coming to your starting page,
 that identifies a user during his whole visit. Using the information gathered here, you could reconstruct the way
-visitors use your FAQ and make necessary adjustments to your categories, content or keywords.
+visitors use your FAQ and make the necessary adjustments to your categories, content or keywords.
 
 ### 5.3.3 View Admin log
 
 The admin log allows you to track any actions taken by users in the admin area of phpMyFAQ. If you feel you have an
-intruder in the system you can find out for sure by checking the admin log.
+intruder in the system, you can find out for sure by checking the admin log.
 
 ### 5.3.4 Search statistics
 
-On the search statistics page you'll get a report about which keywords and how often your users are searching. This
+On the search statistics page, you'll get a report about which keywords and how often your users are searching. This
 information is split into keywords, the number of searches for this term, the language and the overall percentage.
 
 ### 5.3.5 Reports
 
-On the report page you can select various data columns to generate a report about content and usage of your FAQ
+On the report page, you can select various data columns to generate a report about content and usage of your FAQ
 installation. You can export the report then as a CSV file.
 
 ## 5.4 Imports & Exports
@@ -265,7 +269,7 @@ During the backup process, phpMyFAQ generates a hash on the whole backup file an
 of backups will be verified during the process of restoring. If a backup can't be verified, the admin can't use the
 backup file for restore.
 
-To back up the whole data located on your web server you can run our simple backup script located in the folder /scripts.
+To back up the whole data located on your web server, you can run our simple backup script located in the folder /scripts.
 
 ## 5.6 Configuration
 
@@ -324,5 +328,5 @@ Elasticsearch is enabled.
 
 ### 5.6.2 System information
 
-On this page phpMyFAQ displays some relevant system information like PHP version, database version or session path.
-Please use this information when report bugs.
+On this page, phpMyFAQ displays some relevant system information like PHP version, database version or session path.
+Please use this information when reporting bugs.

docs/development.md

@@ -2,7 +2,7 @@
 
 ## 6.1 Customizing phpMyFAQ
 
-phpMyFAQ users have even more customization opportunities. The key feature is the user selectable template sets, there
+phpMyFAQ users have even more customization opportunities. The key feature is the user-selectable template sets, there
 is a templates/default directory where the default layouts get shipped.
 
 In phpMyFAQ code and layout are separated. The layout is based on several template files, that you can modify to suit
@@ -29,6 +29,8 @@ set the following code in src/Bootstrap.php:
 
 ## 6.2 Templating
 
+### 6.2.1 Frontend
+
 The default layout of phpMyFAQ is saved in the **assets/themes/default/templates/index.html** file. This is a normal
 HTML5 file including some variables in double curly brackets like Twig or Handlebars, serving as placeholders for
 content.
@@ -42,13 +44,17 @@ online.
 
 You can change the template as you wish, but you may want to keep the original template in case something goes wrong.
 
+### 6.2.2 Admin backend templates
+
+The admin backend templates are located in the **assets/templates/admin** directory. We use Twig as the template engine.
+
 ## 6.3 REST APIs
 
 phpMyFAQ offers interfaces to access phpMyFAQ installations with other clients like the iPhone App. phpMyFAQ includes a
 REST API and offers APIs for various services like fetching the phpMyFAQ version or doing a search against the
 phpMyFAQ installation.
 
-The API documentation can be found in our [GitHub repository](https://github.com/thorsten/phpMyFAQ/blob/main/API.md).
+The API documentation can be found at [https://api-docs.phpmyfaq.de/](https://api-docs.phpmyfaq.de/).
 
 ## 6.4 phpMyFAQ development
 

docs/installation.md

@@ -97,7 +97,7 @@ even after the successful installation:
 
 All other directories shouldn't be world-writable for your own security.
 
-**Note**: If you're running SELinux, you may need further configuration or you should disable it at all.
+**Note**: If you're running SELinux, you may need further configuration, or you should completely disable it.
 
 The database user needs the permissions for CREATE, DROP, ALTER, INDEX, INSERT, UPDATE, DELETE and SELECT on all tables
 in the database.
@@ -171,8 +171,8 @@ To configure phpMyFAQ point your browser to
 
 Please use your chosen username and your password for your first login into the admin section.
 
-Some variables that does not change regularly, they can be edited in the file _config/constants.php_. You can change
-the
+Some variables that do not change regularly, they can be edited in the file _config/constants.php_.
+You can change
 
 - the time zone of your server (default: "Europe/Berlin")
 - the timeout in the admin section (default: 300 minutes)
@@ -181,7 +181,7 @@ the
 - the incremental value of the solution id (default: 1)
 - the number of records in the Top10 (default: 10)
 - the number of the latest records (default: 5)
-- flag with which Google site map will be forced to use the current phpMyFAQ SEO URL schema (default: true)
+- flag with which a Google site map will be forced to use the current phpMyFAQ SEO URL schema (default: true)
 - the number with which the Tags Cloud list is limited to (default: 50)
 - the number with which the autocomplete list is limited to (default: 20)
 - the default encryption type for passwords
@@ -192,12 +192,12 @@ the
   The term you are looking for should also not be in more than 50% of all your entries, or it will automatically be
   excluded from search. This is not a bug, but rather a feature of MySQL.
 - The search on other databases is using the LIKE operator currently.
-- To improve the search functionality you should consider using Elasticsearch.
+- To improve the search functionality, you should consider using Elasticsearch.
 
 ## 2.6 Automatic user language detection
 
-To set the default language in your browser you have to set a variable that gets passed to the web server. How this is
-done depends on the browser you are using.
+To set the default language in your browser, you have to set a variable that gets passed to the web server.
+How this is done depends on the browser you are using.
 
 - Mozilla Firefox: Tools -> Options -> Content -> Languages
 - Google Chrome / Microsoft Edge / Opera: Settings -> Details -> Language settings
@@ -216,14 +216,14 @@ done depends on the browser you are using.
 
 ## 2.8 Enabling LDAP or Microsoft Active Directory support
 
-If you're entered the correct LDAP or Microsoft Active Directory information during the installation you have to enable
+If you're entered the correct LDAP or Microsoft Active Directory information during the installation, you have to enable
 the LDAP or Microsoft Active Directory support in the configuration in the admin backend. Now your user can authenticate
 themselves in phpMyFAQ against your LDAP server or a Microsoft Active Directory server.
 
-If you need special options for your LDAP or ADS configuration you can change the LDAP configuration in the admin
+If you need special options for your LDAP or ADS configuration, you can change the LDAP configuration in the admin
 configuration panel.
 
-If you want to add LDAP support later, you can use the file **config/ldap.php.original** as template and if you rename
+If you want to add LDAP support later, you can use the file **config/ldap.php.original** as template, and if you rename
 it to **config/ldap.php** you can use the LDAP features as well after you enabled it in the administration backend.
 
 ## 2.9 Using Microsoft Entra ID
@@ -295,7 +295,7 @@ Main features of the PDF export:
 ## 2.11 Static solution ID
 
 phpMyFAQ features a static solution ID which never changes. This ID is visible next to the question on a FAQ record
-page. You may think why do you need such an ID? If you have a record ID _1042_ it is now possible to enter only the ID
+page. You may think why you need such an ID? If you have a record ID _1042_ it is now possible to enter only the ID
 _1042_ in the input field of the full-text search box, and you'll be automatically redirected to the FAQ record with the
 ID _1042_. By default, the numbers start at ID **1000**, but you can change this value in the file _inc/constants.php_.
 You can also change the value of the incrementation of the static IDs.
@@ -332,7 +332,7 @@ Please be aware:
   If you need to change the default key, you will have to re-upload all files.
 - Always memorize your encryption keys. There is no way to decrypt files without a correct key.
 - Files are always saved with names based on a virtual hash generated from several tokens (just like key and issue id
-  etc), so there is no way to asses a file directly using the name it was uploaded under.
+  etc), so there is no way to assess a file directly using the name it was uploaded under.
 - Download continuation isn't supported.
 
 ## 2.14 Server side recommendations
@@ -354,7 +354,7 @@ you, you can specify the language in the class attribute:
 The list of supported language classes is available in the class reference. Classes can also be prefixed with either
 language- or lang-.
 
-To disable highlighting altogether use the "nohighlight" class:
+To disable highlighting altogether, use the "nohighlight" class:
 
     <pre><code class="nohighlight">...</code></pre>
 

docs/update.md

@@ -40,7 +40,8 @@ updated.
 ## Upgrading from phpMyFAQ 3.1.x
 
 Please make a full backup before you run the upgrade!
-First, log in as admin into the admin section and enable the maintenance mode. (Configuration >> Edit Configuration >> Set FAQ in maintenance mode)
+First, log in as admin into the admin section and enable the maintenance mode.
+(Configuration >> Edit Configuration >> Set FAQ in maintenance mode)
 Second, you have to delete all files **except**:
 
 - all files in the directory **config/**
@@ -60,6 +61,7 @@ updated.
 
 Please make a full backup before you run the upgrade!
 First, log in as admin into the admin section and enable the maintenance mode.
+(Configuration >> Edit Configuration >> Set FAQ in maintenance mode)
 Second, you have to delete all files **except**:
 
 - all files in the directory **config/**
@@ -82,6 +84,7 @@ updated.
 
 Please make a full backup before you run the upgrade!
 First, log in as admin into the admin section and enable the maintenance mode.
+(Configuration >> Edit Configuration >> Set FAQ in maintenance mode)
 Second, you have to delete all files **except**:
 
 - all files in the directory **content/**
@@ -98,6 +101,7 @@ updated.
 
 If you're running phpMyFAQ 4.0.0 or later, you can use the built-in automatic upgrade feature.
 Log in as admin into the admin section and enable the maintenance mode.
+(Configuration >> Edit Configuration >> Set FAQ in maintenance mode)
 Then go to the "phpMyFAQ Update" page in the configuration section click through the update wizard:
 
 1. Check for System Health: this checks if your system is ready for the upgrade