Revise the configuration options docs (#7465)

src/Nethermind/Nethermind.Config/IBlocksConfig.cs

@@ -34,7 +34,7 @@ public interface IBlocksConfig : IConfig
     [ConfigItem(Description = "The block time slot, in seconds.", DefaultValue = "12")]
     ulong SecondsPerSlot { get; set; }
 
-    [ConfigItem(Description = "Try to pre-warm the state when processing blocks. Can lead to 2x speedup in main loop block processing.", DefaultValue = "True")]
+    [ConfigItem(Description = "Whether to pre-warm the state when processing blocks. This can lead to an up to 2x speed-up in the main loop block processing.", DefaultValue = "True")]
     bool PreWarmStateOnBlockProcessing { get; set; }
 
     [ConfigItem(Description = "Block Production timeout, in milliseconds.", DefaultValue = "4000")]

src/Nethermind/Nethermind.Consensus/IMiningConfig.cs

@@ -53,7 +53,7 @@ public interface IMiningConfig : IConfig
     [ConfigItem(HiddenFromDocs = true, DisabledForCli = true, DefaultValue = "null")]
     IBlocksConfig? BlocksConfig { get; }
     [ConfigItem(
-    Description = "Url for an external signer like clef: https://github.com/ethereum/go-ethereum/blob/master/cmd/clef/tutorial.md",
+    Description = "The URL of an external signer like [Clef](https://github.com/ethereum/go-ethereum/blob/master/cmd/clef/tutorial.md).",
     HiddenFromDocs = false,
     DefaultValue = "null")]
     string? Signer { get; set; }

src/Nethermind/Nethermind.Db/IPruningConfig.cs

@@ -93,9 +93,9 @@ public interface IPruningConfig : IConfig
     [ConfigItem(Description = "Whether to enables available disk space check.", DefaultValue = "true")]
     bool AvailableSpaceCheckEnabled { get; set; }
 
-    [ConfigItem(Description = "[TECHNICAL] Ratio of memory out of CacheMb to allocate for LRU used to track past keys for live pruning.", DefaultValue = "0.1")]
+    [ConfigItem(Description = "The ratio of memory out of `Pruning.CacheMb` to allocate for the LRU cache, used to track past keys for live pruning.", DefaultValue = "0.1")]
     double TrackedPastKeyCountMemoryRatio { get; set; }
 
-    [ConfigItem(Description = "Past N state before state gets pruned Used to determine how old of a state to keep from the head.", DefaultValue = "64")]
+    [ConfigItem(Description = "The number of past states before the state gets pruned. Used to determine how old of a state to keep from the head.", DefaultValue = "64")]
     int PruningBoundary { get; set; }
 }

src/Nethermind/Nethermind.JsonRpc/IJsonRpcConfig.cs

@@ -108,7 +108,7 @@ public interface IJsonRpcConfig : IConfig
 
 
     [ConfigItem(
-        Description = "The max number of logs per response. For method `eth_getLogs`. If 0 then no limit.",
+        Description = "The max number of logs per response for the `eth_getLogs` JSON-RPC method. `0` to lift the limit.",
         DefaultValue = "20000")]
     public int MaxLogsPerResponse { get; set; }
 
@@ -161,9 +161,9 @@ public interface IJsonRpcConfig : IConfig
     [ConfigItem(Description = "The max batch size limit for batched JSON-RPC calls.", DefaultValue = "33554432")]
     long? MaxBatchResponseBodySize { get; set; }
 
-    [ConfigItem(Description = "The max blocks count limit for eth_simulate JSON-RPC calls.", DefaultValue = "256")]
+    [ConfigItem(Description = "The max block count limit for the `eth_simulate` JSON-RPC method.", DefaultValue = "256")]
     long? MaxSimulateBlocksCap { get; set; }
 
-    [ConfigItem(Description = "The error margin used in eth_estimateGas expressed in basis points.", DefaultValue = "150")]
+    [ConfigItem(Description = "The error margin used in the `eth_estimateGas` JSON-RPC method, in basis points.", DefaultValue = "150")]
     int EstimateErrorMargin { get; set; }
 }

src/Nethermind/Nethermind.Optimism/IOptimismConfig.cs

@@ -7,6 +7,6 @@ namespace Nethermind.Optimism;
 
 public interface IOptimismConfig : IConfig
 {
-    [ConfigItem(Description = "Sequencer address", DefaultValue = "null")]
+    [ConfigItem(Description = "The sequencer address.", DefaultValue = "null")]
     string? SequencerUrl { get; set; }
 }