Merge pull request #171 from jtdub/3.4.0

Add Fortigate docs, prepare release

Author: jtdub

README.md

@@ -8,6 +8,7 @@ Hierarchical Configuration has been used extensively on:
 - [x] Cisco IOSXR
 - [x] Cisco NXOS
 - [x] Arista EOS
+- [x] Fortinet FortiOS
 - [x] HP Procurve (Aruba AOSS)
 
 In addition to the Cisco-style syntax, hier_config offers experimental support for Juniper-style configurations using set and delete commands. This allows users to remediate Junos configurations in native syntax. However, please note that Juniper syntax support is still in an experimental phase and has not been tested extensively. Use with caution in production environments.
@@ -17,7 +18,7 @@ In addition to the Cisco-style syntax, hier_config offers experimental support f
 
 Hier Config is compatible with any NOS that utilizes a structured CLI syntax similar to Cisco IOS or Junos OS.
 
-The code documentation can be found at: https://hier-config.readthedocs.io/en/latest/
+The code documentation can be found at: [Hier Config documentation](https://hier-config.readthedocs.io/en/latest/).
 
 Installation
 ============

docs/drivers.md

@@ -35,6 +35,7 @@ The following drivers are included in Hier Config:
 - **CISCO_XR**
 - **CISCO_NXOS**
 - **GENERIC**
+- **FORTINET_FORTIOS**
 - **HP_COMWARE5**
 - **HP_PROCURVE**
 - **JUNIPER_JUNOS**
@@ -49,6 +50,31 @@ from hier_config import get_hconfig_driver, Platform
 driver = get_hconfig_driver(Platform.CISCO_IOS)
 ```
 
+### Fortinet FortiOS Driver
+
+Fortinet firewalls model their CLI around `config` and `edit` blocks that are
+terminated with `next` and `end`. The `FORTINET_FORTIOS` driver captures those
+patterns and makes sure remediation output keeps the indentation and closure
+FortiOS expects. Highlights include:
+
+- Preserves the `set`/`unset` pairing by swapping declarations and negations
+    automatically when hier_config determines a change is required.
+- Treats sibling `config` blocks as duplicates when appropriate so that
+    multiple objects such as policies or firewall addresses can be compared in
+    a stable order.
+- Normalizes bare `next` and `end` tokens into indented versions to match the
+    format FortiOS emits on the device.
+- Overrides idempotency matching to require that the same object name exists on
+    both sides before a command is considered already present.
+
+Activate the driver with the standard helper:
+
+```python
+from hier_config import Platform, get_hconfig_driver
+
+driver = get_hconfig_driver(Platform.FORTINET_FORTIOS)
+```
+
 ### Structure of Each Section and How Rules Are Built
 
 In Hier Config, the rules within a driver are organized into sections, each targeting a specific aspect of device configuration processing. These sections use Pydantic models to define the behavior and ensure consistency. Here's a breakdown of each section and its associated models:

docs/index.md

@@ -8,6 +8,7 @@ Hierarchical Configuration has been used extensively on:
 - [x] Cisco IOSXR
 - [x] Cisco NXOS
 - [x] Arista EOS
+- [x] Fortinet FortiOS
 - [x] HP Procurve (Aruba AOSS)
 
 In addition to the Cisco-style syntax, hier_config offers experimental support for Juniper-style configurations using set and delete commands. This allows users to remediate Junos configurations in native syntax. However, please note that Juniper syntax support is still in an experimental phase and has not been tested extensively. Use with caution in production environments.