refactor: 🔨 optimize logging and add XML documentation

- Remove excessive debug logging across all components for better performance
- Add minimal XML documentation comments for all public APIs (resolves CS1591 warnings)
- Streamline logging to essential information only (errors, warnings, key operations)
- Improve code clarity by reducing log noise while maintaining debuggability
- Clean up debugging guide to focus on practical troubleshooting

Author: erlendellefsen

JsonApiToolkit/Attributes/AllowedIncludesAttribute.cs

@@ -9,27 +9,24 @@
 namespace JsonApiToolkit.Attributes;
 
 /// <summary>
-/// Action filter attribute that restricts which relationships can be included in JSON:API responses.
+/// Restricts which relationships can be included in responses.
+/// Returns 403 Forbidden if requested includes don't match the whitelist.
 /// </summary>
-/// <remarks>
-/// This attribute validates the 'include' query parameter against a whitelist of allowed includes.
-/// If a client requests an include that is not in the whitelist, a 403 Forbidden error is returned.
-/// </remarks>
 [AttributeUsage(AttributeTargets.Method, AllowMultiple = false)]
 public class AllowedIncludesAttribute : ActionFilterAttribute
 {
     private readonly string[] _allowedIncludes;
     private readonly Dictionary<string, IncludePattern> _compiledPatterns;
 
     /// <summary>
-    /// Gets the list of allowed include patterns.
+    /// Gets the allowed include patterns.
     /// </summary>
     public string[] AllowedIncludes => _allowedIncludes;
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="AllowedIncludesAttribute"/> class.
+    /// Initializes a new instance with the specified allowed include patterns.
     /// </summary>
-    /// <param name="allowedIncludes">The list of allowed include patterns. If empty, no includes are allowed.</param>
+    /// <param name="allowedIncludes">Include patterns to allow (supports wildcards).</param>
     public AllowedIncludesAttribute(params string[] allowedIncludes)
     {
         _allowedIncludes = allowedIncludes ?? [];
@@ -44,9 +41,8 @@ public AllowedIncludesAttribute(params string[] allowedIncludes)
     }
 
     /// <summary>
-    /// Validates the include query parameters before the action executes.
+    /// Validates requested includes against the allowed patterns.
     /// </summary>
-    /// <param name="context">The action executing context.</param>
     public override void OnActionExecuting(ActionExecutingContext context)
     {
         // Skip validation for JsonApiCreated methods

JsonApiToolkit/Controllers/JsonApiController.cs

@@ -6,35 +6,13 @@
 namespace JsonApiToolkit.Extensions;
 
 /// <summary>
-/// Provides extension methods for applying JSON:API query parameters to IQueryable data sources.
+/// Extension methods for applying JSON:API query parameters to IQueryable.
 /// </summary>
-/// <remarks>
-/// Consolidates the application of filtering, sorting, and pagination in a single convenient extension method.
-/// </remarks>
 public static class QueryableExtensions
 {
     /// <summary>
-    /// Applies all JSON:API query parameters to an IQueryable data source in the correct order.
+    /// Applies all JSON:API parameters: filters → sort (defaults to Id) → pagination.
     /// </summary>
-    /// <typeparam name="T">The entity type of the queryable</typeparam>
-    /// <param name="query">The source IQueryable to apply parameters to</param>
-    /// <param name="parameters">The complete set of JSON:API query parameters</param>
-    /// <returns>A new IQueryable with all query parameters applied</returns>
-    /// <remarks>
-    /// Applies parameters in the following order:
-    /// <list type="number">
-    /// <item>
-    /// <description>Filtering - narrows the result set based on field conditions</description>
-    /// </item>
-    /// <item>
-    /// <description>Sorting - orders the results (defaults to Id ascending if not specified)</description>
-    /// </item>
-    /// <item>
-    /// <description>Pagination - limits the number of results and supports paging</description>
-    /// </item>
-    /// </list>
-    /// This is the recommended method for applying all JSON:API query parameters in a single operation.
-    /// </remarks>
     public static IQueryable<T> ApplyJsonApiParameters<T>(
         this IQueryable<T> query,
         QueryParameters parameters
@@ -58,12 +36,8 @@ QueryParameters parameters
     }
 
     /// <summary>
-    /// Dynamically applies EF Core Include() calls for each include path (dot notation supported).
+    /// Applies EF Core Include() for each path (supports dot notation).
     /// </summary>
-    /// <typeparam name="T">The entity type.</typeparam>
-    /// <param name="query">The source queryable.</param>
-    /// <param name="includePaths">A list of include paths (e.g. "todo", "todo.category").</param>
-    /// <returns>The queryable with all includes applied.</returns>
     public static IQueryable<T> ApplyIncludes<T>(
         this IQueryable<T> query,
         List<string>? includePaths
@@ -81,17 +55,9 @@ public static IQueryable<T> ApplyIncludes<T>(
     }
 
     /// <summary>
-    /// Dynamically applies EF Core Include() calls using AsSingleQuery() to prevent split query issues.
+    /// Applies EF Core Include() using AsSingleQuery() to prevent split query issues with pagination.
+    /// Forces single query with JOINs instead of separate queries.
     /// </summary>
-    /// <typeparam name="T">The entity type.</typeparam>
-    /// <param name="query">The source queryable.</param>
-    /// <param name="includePaths">A list of include paths (e.g. "todo", "todo.category").</param>
-    /// <returns>The queryable with all includes applied using single query mode.</returns>
-    /// <remarks>
-    /// Use this method when pagination is present to avoid EF Core split query optimization issues
-    /// that can cause includes to load data for wrong entities or no entities at all.
-    /// Forces EF Core to use a single query with JOINs instead of separate queries.
-    /// </remarks>
     public static IQueryable<T> ApplyIncludesSingleQuery<T>(
         this IQueryable<T> query,
         List<string>? includePaths
@@ -101,7 +67,6 @@ public static IQueryable<T> ApplyIncludesSingleQuery<T>(
         if (includePaths == null || includePaths.Count == 0)
             return query;
 
-        // Force single query to prevent EF Core split query issues with pagination
         query = query.AsSingleQuery();
 
         foreach (string path in includePaths)