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.models.object.json

@@ -2,7 +2,7 @@
   "module": "docforge.models.object",
   "content": {
     "path": "docforge.models.object",
-    "docstring": "This module defines the DocObject class, the fundamental recursive unit of the\ndoc-forge documentation models. A DocObject represents a single Python entity\n(class, function, method, or attribute) and its nested members.",
+    "docstring": "Documentation model representing individual Python objects.\n\nThis module defines the ``DocObject`` class, the fundamental recursive unit of\nthe doc-forge documentation model. Each ``DocObject`` represents a Python\nentity such as a class, function, method, or attribute, and may contain nested\nmembers that form a hierarchical documentation structure.",
     "objects": {
       "Dict": {
         "name": "Dict",
@@ -29,8 +29,8 @@
         "name": "DocObject",
         "kind": "class",
         "path": "docforge.models.object.DocObject",
-        "signature": "<bound method Class.signature of Class('DocObject', 10, 76)>",
-        "docstring": "Represents a documented Python object (class, function, method, etc.).\n\nAttributes:\n    name: Local name of the object.\n    kind: Type of object (e.g., 'class', 'function', 'attribute').\n    path: Full dotted import path to the object.\n    signature: Callable signature, if applicable.\n    docstring: Raw docstring content extracted from the source.\n    members: Dictionary mapping member names to their DocObject representations.",
+        "signature": "<bound method Class.signature of Class('DocObject', 13, 90)>",
+        "docstring": "Representation of a documented Python object.\n\nA ``DocObject`` models a single Python entity discovered during\nintrospection. Objects may contain nested members, allowing the structure\nof modules, classes, and other containers to be represented recursively.\n\nAttributes:\n    name: Local name of the object.\n    kind: Type of object (for example ``class``, ``function``,\n        ``method``, or ``attribute``).\n    path: Fully qualified dotted path to the object.\n    signature: Callable signature if the object represents a callable.\n    docstring: Raw docstring text extracted from the source code.\n    members: Mapping of member names to child ``DocObject`` instances.",
         "members": {
           "name": {
             "name": "name",
@@ -78,22 +78,22 @@
             "name": "add_member",
             "kind": "function",
             "path": "docforge.models.object.DocObject.add_member",
-            "signature": "<bound method Function.signature of Function('add_member', 48, 55)>",
-            "docstring": "Add a child member to this object (e.g., a method to a class).\n\nArgs:\n    obj: The child DocObject to add."
+            "signature": "<bound method Function.signature of Function('add_member', 56, 66)>",
+            "docstring": "Add a child documentation object.\n\nThis is typically used when attaching methods to classes or\nnested objects to their parent containers.\n\nArgs:\n    obj: Documentation object to add as a member."
           },
           "get_member": {
             "name": "get_member",
             "kind": "function",
             "path": "docforge.models.object.DocObject.get_member",
-            "signature": "<bound method Function.signature of Function('get_member', 57, 67)>",
-            "docstring": "Retrieve a child member by name.\n\nArgs:\n    name: The name of the member.\n\nReturns:\n    The requested DocObject."
+            "signature": "<bound method Function.signature of Function('get_member', 68, 81)>",
+            "docstring": "Retrieve a member object by name.\n\nArgs:\n    name: Name of the member to retrieve.\n\nReturns:\n    The corresponding ``DocObject`` instance.\n\nRaises:\n    KeyError: If the member does not exist."
           },
           "get_all_members": {
             "name": "get_all_members",
             "kind": "function",
             "path": "docforge.models.object.DocObject.get_all_members",
-            "signature": "<bound method Function.signature of Function('get_all_members', 69, 76)>",
-            "docstring": "Get all members of this object.\n\nReturns:\n    An iterable of child DocObject instances."
+            "signature": "<bound method Function.signature of Function('get_all_members', 83, 90)>",
+            "docstring": "Return all child members of the object.\n\nReturns:\n    An iterable of ``DocObject`` instances representing nested members."
           }
         }
       }