Improve documentation look & feel via MkDocs Material template enhancements (#5)

# Improve documentation look & feel via MkDocs Material template enhancements

## Summary

This MR improves the overall **documentation experience and visual presentation** of the doc-forge docs by enhancing the MkDocs Material template configuration.

The changes focus on **navigation usability, code readability, and richer Markdown rendering**, resulting in a cleaner and more professional documentation site.

Docstring changes were made across the codebase for consistency, but this MR description focuses on the **template and presentation improvements**.

---

## Navigation Improvements

The navigation system has been enhanced to provide a clearer structure and better discoverability.

Key improvements include:

* Section-aware navigation in the sidebar
* Automatic expansion of module/package hierarchy
* Scroll tracking within the sidebar
* Clickable package index pages

Material navigation features added:

* `navigation.sections`
* `navigation.expand`
* `navigation.tracking`
* `navigation.indexes`

This results in a **single cohesive navigation tree** that exposes the entire documentation hierarchy from the sidebar.

---

## Code Block Improvements

Code blocks previously appeared relatively plain. The template now enables richer syntax highlighting and improved readability.

Enhancements include:

* Syntax highlighting using `pymdownx.highlight`
* Line numbers for code blocks
* Anchored line numbers for deep linking
* Improved fenced code block rendering

Additional Material features:

* `content.code.copy` — copy button for code blocks
* `content.code.annotate` — support for code annotations

These changes significantly improve the readability of examples and API snippets throughout the documentation.

---

## Markdown Rendering Enhancements

Additional Markdown extensions were enabled to support richer documentation features:

* `pymdownx.superfences` for advanced fenced blocks
* `pymdownx.inlinehilite` for inline code highlighting
* `pymdownx.snippets` for reusable snippets
* `admonition` and `pymdownx.details` for callouts and collapsible sections
* `pymdownx.tabbed` for tabbed content blocks
* `pymdownx.tasklist` for checklist-style items
* `tables`, `footnotes`, and advanced formatting extensions

These extensions make it easier to write expressive and structured documentation.

---

## Search Experience

The documentation search experience has been improved using Material search features:

* `search.highlight`
* `search.share`
* `search.suggest`

These enhancements provide:

* highlighted search matches
* sharable search URLs
* auto-suggestions while typing

---

## mkdocstrings Improvements

The mkdocstrings configuration has been expanded to produce clearer API documentation.

Notable improvements include:

* grouping objects by category
* explicit category headings
* improved symbol headings
* cleaner object path display

This results in more structured API documentation pages.

---

## Result

Overall, these changes provide:

* cleaner and more intuitive navigation
* significantly improved code presentation
* richer Markdown capabilities
* better search usability

The documentation now has a **more polished, modern appearance** and improved usability for both readers and contributors.

Reviewed-on: #5
Co-authored-by: Vishesh 'ironeagle' Bangotra <aetoskia@gmail.com>
Co-committed-by: Vishesh 'ironeagle' Bangotra <aetoskia@gmail.com>

mcp_docs/modules/docforge.nav.resolver.json

@@ -2,7 +2,7 @@
   "module": "docforge.nav.resolver",
   "content": {
     "path": "docforge.nav.resolver",
-    "docstring": "This module contains the logic for resolving a NavSpec against the physical\nfilesystem. It expands globs and validates that all referenced documents\nactually exist on disk.",
+    "docstring": "Navigation resolution utilities.\n\nThis module resolves a ``NavSpec`` against the filesystem by expanding glob\npatterns and validating that referenced documentation files exist.",
     "objects": {
       "Path": {
         "name": "Path",
@@ -44,7 +44,7 @@
         "kind": "class",
         "path": "docforge.nav.resolver.NavSpec",
         "signature": "<bound method Alias.signature of Alias('NavSpec', 'docforge.nav.spec.NavSpec')>",
-        "docstring": "Parsed representation of the docforge navigation specification file.\n\nAttributes:\n    home: Path to the home document (e.g., 'index.md').\n    groups: Mapping of group titles to lists of path patterns/globs.",
+        "docstring": "Parsed representation of a navigation specification.\n\nA ``NavSpec`` describes the intended documentation navigation layout before\nit is resolved against the filesystem.\n\nAttributes:\n    home: Relative path to the documentation home page (for example\n        ``index.md``).\n    groups: Mapping of navigation group titles to lists of file patterns\n        or glob expressions.",
         "members": {
           "home": {
             "name": "home",
@@ -65,14 +65,14 @@
             "kind": "function",
             "path": "docforge.nav.resolver.NavSpec.load",
             "signature": "<bound method Alias.signature of Alias('load', 'docforge.nav.spec.NavSpec.load')>",
-            "docstring": "Load a NavSpec from a YAML file.\n\nArgs:\n    path: The filesystem path to the YAML file.\n\nReturns:\n    A NavSpec instance.\n\nRaises:\n    FileNotFoundError: If the path does not exist.\n    ValueError: If the file content is not a valid NavSpec mapping."
+            "docstring": "Load a navigation specification from a YAML file.\n\nArgs:\n    path: Filesystem path to the navigation specification file.\n\nReturns:\n    A ``NavSpec`` instance representing the parsed configuration.\n\nRaises:\n    FileNotFoundError: If the specified file does not exist.\n    ValueError: If the file contents are not a valid navigation\n        specification."
           },
           "all_patterns": {
             "name": "all_patterns",
             "kind": "function",
             "path": "docforge.nav.resolver.NavSpec.all_patterns",
             "signature": "<bound method Alias.signature of Alias('all_patterns', 'docforge.nav.spec.NavSpec.all_patterns')>",
-            "docstring": "Get all path patterns referenced in the specification.\n\nReturns:\n    A list of all patterns (home plus all groups)."
+            "docstring": "Return all path patterns referenced by the specification.\n\nReturns:\n    A list containing the home document (if defined) and all\n    group pattern entries."
           }
         }
       },
@@ -80,8 +80,8 @@
         "name": "ResolvedNav",
         "kind": "class",
         "path": "docforge.nav.resolver.ResolvedNav",
-        "signature": "<bound method Class.signature of Class('ResolvedNav', 15, 56)>",
-        "docstring": "Represents a navigation structure where all patterns and paths have been\nresolved against the actual filesystem contents.\n\nAttributes:\n    home: Resolved relative path to the home page.\n    groups: Mapping of group titles to lists of absolute or relative Path objects.",
+        "signature": "<bound method Class.signature of Class('ResolvedNav', 16, 65)>",
+        "docstring": "Resolved navigation structure.\n\nA ``ResolvedNav`` represents navigation data after glob patterns have been\nexpanded and paths validated against the filesystem.\n\nAttributes:\n    home: Relative path to the documentation home page.\n    groups: Mapping of navigation group titles to lists of resolved\n        documentation file paths.",
         "members": {
           "home": {
             "name": "home",
@@ -101,8 +101,8 @@
             "name": "all_files",
             "kind": "function",
             "path": "docforge.nav.resolver.ResolvedNav.all_files",
-            "signature": "<bound method Function.signature of Function('all_files', 43, 56)>",
-            "docstring": "Get an iterable of all resolved files in the navigation structure.\n\nReturns:\n    An iterable of Path objects."
+            "signature": "<bound method Function.signature of Function('all_files', 47, 65)>",
+            "docstring": "Iterate over all files referenced by the navigation structure.\n\nReturns:\n    An iterable of ``Path`` objects representing documentation files.\n\nRaises:\n    RuntimeError: If the home page is defined but the documentation\n        root is not available for resolution."
           }
         }
       },
@@ -110,8 +110,8 @@
         "name": "resolve_nav",
         "kind": "function",
         "path": "docforge.nav.resolver.resolve_nav",
-        "signature": "<bound method Function.signature of Function('resolve_nav', 59, 124)>",
-        "docstring": "Create a ResolvedNav by processing a NavSpec against the filesystem.\nThis expands globs and validates the existence of referenced files.\n\nArgs:\n    spec: The navigation specification to resolve.\n    docs_root: The root directory for documentation files.\n\nReturns:\n    A ResolvedNav instance.\n\nRaises:\n    FileNotFoundError: If a pattern doesn't match any files or the docs_root doesn't exist."
+        "signature": "<bound method Function.signature of Function('resolve_nav', 68, 136)>",
+        "docstring": "Resolve a navigation specification against the filesystem.\n\nThe function expands glob patterns defined in a ``NavSpec`` and verifies\nthat referenced documentation files exist within the documentation root.\n\nArgs:\n    spec: Navigation specification describing documentation layout.\n    docs_root: Root directory containing documentation Markdown files.\n\nReturns:\n    A ``ResolvedNav`` instance containing validated navigation paths.\n\nRaises:\n    FileNotFoundError: If the documentation root does not exist or a\n        navigation pattern does not match any files."
       },
       "Optional": {
         "name": "Optional",