fix: clean up whitespace in various files, update documentation structure, and enhance pagination metadata handling

Author: bubaley

.github/workflows/docs-check.yml

@@ -45,9 +45,9 @@ jobs:
           import os
           import re
           import sys
-          
+
           broken_links = []
-          
+
           for root, dirs, files in os.walk('docs'):
               for file in files:
                   if file.endswith('.md'):
@@ -66,7 +66,7 @@ jobs:
                                   target_path = os.path.join('docs', link_url)
                                   if not os.path.exists(target_path):
                                       broken_links.append(f'{filepath}: {link_url}')
-          
+
           if broken_links:
               print('Broken internal links found:')
               for link in broken_links:
@@ -81,4 +81,4 @@ jobs:
           # Basic spell check for common technical terms
           echo "Performing basic spell check..."
           # This is a simple check - in production you might want to use a proper spell checker
-          find docs -name "*.md" -exec grep -i "teh\|adn\|nad\|hte\|tha\|documetnation\|implmentation" {} + | head -10 || true 
+          find docs -name "*.md" -exec grep -i "teh\|adn\|nad\|hte\|tha\|documetnation\|implmentation" {} + | head -10 || true

.github/workflows/docs.yml

@@ -53,7 +53,7 @@ jobs:
       - name: Build documentation
         run: |
           uv run mkdocs build --clean --strict
-          
+
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
@@ -79,4 +79,4 @@ jobs:
     needs: build
     steps:
       - name: Documentation build successful
-        run: echo "Documentation built successfully for PR" 
+        run: echo "Documentation built successfully for PR"

Makefile

@@ -40,5 +40,3 @@ docs-clean:  ## Clean documentation build artifacts
 help:
 	@echo "Usage: make <target>"
 	@awk 'BEGIN {FS = ":.*##"} /^[0-9a-zA-Z_-]+:.*?## / { printf "  * %-20s -%s\n", $$1, $$2 }' $(MAKEFILE_LIST)
-
-

README.md

@@ -125,7 +125,7 @@ uvicorn main:app --reload
 """
 This creates the following endpoints:
 - GET /companies/ - List companies with pagination
-- POST /companies/ - Create new company  
+- POST /companies/ - Create new company
 - GET /companies/{item_id}/ - Get specific company
 - PUT /companies/{item_id}/ - Update company
 - DELETE /companies/{item_id}/ - Delete company
@@ -156,7 +156,7 @@ GET /companies/1/ (with single wrapper):
 {
   "data": {
     "id": 1,
-    "name": "Acme Corp", 
+    "name": "Acme Corp",
     "full_name": "Acme Corporation Ltd.",
     "created_at": "2023-01-01T10:00:00Z",
     "updated_at": "2023-01-01T10:00:00Z"

docs/DEVELOPMENT.md

@@ -59,4 +59,4 @@ When adding new documentation:
 2. Use clear, descriptive headings
 3. Include practical examples
 4. Test code examples before committing
-5. Update navigation in `mkdocs.yml` if needed 
+5. Update navigation in `mkdocs.yml` if needed

docs/assets/extra.css

@@ -41,7 +41,7 @@
   --content-padding: 1rem;
   --font-weight-semibold: 600;
   --font-weight-normal: 400;
-  
+
 }
 
 .md-nav__link--active, .md-tabs__item--active {
@@ -95,7 +95,7 @@ code {
   border-radius: var(--border-radius-small) !important;
 }
 
-li code, td code {
+li code, td code, p > code {
   border: 1px solid var(--border-color) !important;
 }
 
@@ -190,4 +190,4 @@ pre .md-code__content,
 }
 .admonition-title {
   padding: 0.7rem 2.3rem !important;
-}
+}

docs/index.md

@@ -129,7 +129,7 @@ uvicorn main:app --reload
 """
 This creates the following endpoints:
 - GET /companies/ - List companies with pagination
-- POST /companies/ - Create new company  
+- POST /companies/ - Create new company
 - GET /companies/{item_id}/ - Get specific company
 - PUT /companies/{item_id}/ - Update company
 - DELETE /companies/{item_id}/ - Delete company
@@ -160,7 +160,7 @@ GET /companies/1/ (with single wrapper):
 {
   "data": {
     "id": 1,
-    "name": "Acme Corp", 
+    "name": "Acme Corp",
     "full_name": "Acme Corporation Ltd.",
     "created_at": "2023-01-01T10:00:00Z",
     "updated_at": "2023-01-01T10:00:00Z"
@@ -169,7 +169,7 @@ GET /companies/1/ (with single wrapper):
 
 GET /companies/stats/ (custom action):
 {
-  "data": 123
+  "total": 123
 }
 """
 ```
@@ -222,7 +222,7 @@ Ready to build amazing APIs? Start with our [Quick Start guide](quick-start.md)
 Want to dive deeper? Explore our comprehensive guides:
 
 - [ViewSets](viewsets/index.md) - Learn about the core ViewSet concepts
-- [Schemas](schemas.md) - Master schema generation and meta classes
+- [Meta & Schemas](schemas.md) - Master schema generation and meta classes
 - [Permissions](permissions.md) - Secure your APIs with permission classes
 - [Pagination](pagination.md) - Implement efficient data pagination
 - [State Management](state.md) - Manage request-scoped state