doc inline fixes

Author: eadwinCode

docs/index.md

@@ -11,11 +11,11 @@
 [![PyPI version](https://img.shields.io/pypi/v/ellar.svg)](https://pypi.python.org/pypi/ellar)
 [![PyPI version](https://img.shields.io/pypi/pyversions/ellar.svg)](https://pypi.python.org/pypi/ellar)
 
-## Overview
+## **Overview**
 
 Ellar is a modern, fast, and lightweight ASGI framework for building scalable web applications and APIs with Python. Built on top of Starlette and inspired by the best practices of frameworks like NestJS, Ellar combines the power of async Python with elegant architecture patterns.
 
-## ✨ Key Features
+## **✨ Key Features**
 
 - 🚀 **High Performance**: Built on ASGI standards for maximum performance and scalability
 - 💉 **Dependency Injection**: Built-in DI system for clean and maintainable code architecture
@@ -27,9 +27,9 @@ Ellar is a modern, fast, and lightweight ASGI framework for building scalable we
 - 🔌 **WebSocket Support**: Real-time bidirectional communication capabilities
 - 🧪 **Testing Utilities**: Comprehensive testing tools for unit and integration tests
 
-## 🚀 Getting Started
+## **🚀 Getting Started**
 
-### Installation
+### **Installation**
 
 ```bash
 # Create and activate virtual environment (recommended)
@@ -40,7 +40,7 @@ source venv/bin/activate  # On Windows use: venv\Scripts\activate
 pip install ellar
 ```
 
-### Basic Example
+### **Basic Example**
 
 ```python
 from ellar.common import get, Controller, ControllerBase
@@ -59,7 +59,7 @@ if __name__ == "__main__":
     uvicorn.run("main:app", port=5000, reload=True)
 ```
 
-## 📚 Complete Example
+## **📚 Complete Example**
 
 ```python
 from ellar.common import Body, Controller, ControllerBase, delete, get, post, put, Serializer
@@ -101,7 +101,7 @@ app = AppFactory.create_app(
 )
 ```
 
-## 🔧 Requirements
+## **🔧 Requirements**
 
 ### Core Dependencies
 - Python >= 3.8
@@ -115,15 +115,15 @@ app = AppFactory.create_app(
 - python-multipart - For form data parsing
 - itsdangerous - For security features
 
-## 📖 Documentation Structure
+## **📖 Documentation Structure**
 
 - [Quick Start Guide](quick-project.md)
-- [Basic Concepts](basics/index.md)
+- [Basic Concepts](overview/step-one.md)
 - [Security & Authentication](security/authentication/index.md)
 - [OpenAPI Integration](openapi/index.md)
 - [API Reference](references/index.md)
 
-## 🤝 Contributing
+## **🤝 Contributing**
 
 We welcome contributions! Here's how you can help:
 
@@ -135,10 +135,10 @@ We welcome contributions! Here's how you can help:
 
 See [CONTRIBUTING.md](https://github.com/python-ellar/ellar/blob/main/docs/contribution.md) for detailed guidelines.
 
-## 📝 License
+## **📝 License**
 
 Ellar is [MIT Licensed](https://github.com/python-ellar/ellar/blob/main/LICENSE).
 
-## 👤 Author
+## **👤 Author**
 
 Ezeudoh Tochukwu [@eadwinCode](https://github.com/eadwinCode)

docs/security/authentication/api-key-authentication.md

@@ -1,18 +1,18 @@
-# API Key Authentication in Ellar
+# **API Key Authentication in Ellar**
 
 This guide demonstrates how to implement API Key authentication in Ellar using both header-based and query parameter-based approaches.
 
-## Overview
+## **Overview**
 
 API Key authentication is a simple yet effective way to secure your APIs. Ellar provides built-in support for three types of API Key authentication:
 
 1. Header-based API Key
 2. Query Parameter-based API Key
 3. Cookie-based API Key
 
-## Implementation Methods
+## **Implementation Methods**
 
-### 1. Using Authentication Handler
+### 1. **Using Authentication Handler**
 
 ```python
 # auth/api_key_scheme.py
@@ -69,7 +69,7 @@ application = AppFactory.create_from_app_module(
 use_authentication_schemes([HeaderAPIKeyAuth, QueryAPIKeyAuth])
 ```
 
-### 2. Using Guard Strategy
+### 2. **Using Guard Strategy**
 
 ```python
 # auth/guards.py
@@ -111,7 +111,7 @@ class QueryAPIKeyGuard(GuardAPIKeyQuery):
         self.raise_exception()
 ```
 
-## Controller Implementation
+## **Controller Implementation**
 
 ```python
 from ellar.common import Controller, get
@@ -126,7 +126,7 @@ class APIController:
         return {"message": "Protected data"}
 ```
 
-## Testing the Implementation
+## **Testing the Implementation**
 
 ```bash
 # Using Header-based API Key
@@ -137,26 +137,26 @@ curl http://localhost:8000/api/data \
 curl "http://localhost:8000/api/data?api_key=your-secret-api-key"
 ```
 
-## Security Best Practices
+## **Security Best Practices**
 
 1. **API Key Storage**:
-   - Never hardcode API keys in source code
-   - Use environment variables or secure key management systems
-   - Rotate API keys periodically
+    - Never hardcode API keys in source code
+    - Use environment variables or secure key management systems
+    - Rotate API keys periodically
 
 2. **Transport Security**:
-   - Always use HTTPS in production
-   - Consider implementing rate limiting
-   - Log and monitor API key usage
+    - Always use HTTPS in production
+    - Consider implementing rate limiting
+    - Log and monitor API key usage
 
 3. **Key Management**:
-   - Implement API key rotation
-   - Maintain an audit trail of API key usage
-   - Implement key revocation mechanisms
+    - Implement API key rotation
+    - Maintain an audit trail of API key usage
+    - Implement key revocation mechanisms
 
-## Advanced Implementation
+## **Advanced Implementation**
 
-### API Key with Scopes
+### **API Key with Scopes**
 
 ```python
 from typing import List
@@ -186,7 +186,7 @@ class ScopedAPIKeyAuth(HeaderAPIKeyAuthenticationHandler):
         return None
 ```
 
-## Manual OpenAPI Integration
+## **Manual OpenAPI Integration**
 
 Ellar automatically generates OpenAPI documentation when you use and class in `ellar.auth.handlers` and `ellar.auth.guards`. But if you want to manually add it, you can do so by using the `OpenAPIDocumentBuilder` class.
 
@@ -210,7 +210,7 @@ document_builder.add_security_scheme(
 )
 ```
 
-## Custom Error Handling
+## **Custom Error Handling**
 
 ```python
 from ellar.common import IExecutionContext
@@ -228,8 +228,8 @@ def invalid_api_key_exception_handler(ctx: IExecutionContext, exc: Exception) ->
         }
     )
 ```
-See [Custom Error Handling](../overview/exception_handling.md) for more information.
+See [Custom Error Handling](../../overview/exception_handling.md) for more information.
 
-## Complete Examples
+## **Complete Examples**
 
 For a complete working example of API Key authentication, visit the [Ellar examples repository](https://github.com/python-ellar/ellar/tree/main/examples). 

docs/security/authentication/auth-handler-strategy.md

@@ -7,7 +7,7 @@ happens just before route function is executed.
 Ellar provides `BaseAuthenticationHandler` contract which defines what is required to set up any authentication strategy. 
 We are going to make some modifications on the existing project to see how we can achieve the same result and to show how authentication handlers in ellar.
 
-### Creating a JWT Authentication Handler
+### **Creating a JWT Authentication Handler**
 Just like AuthGuard, we need to create its equivalent. But first we need to create a `auth_scheme.py` at the root level 
 of your application for us to define a `JWTAuthentication` handler. 
 

docs/security/authentication/index.md

@@ -1,27 +1,27 @@
-# Authentication in Ellar
+# **Authentication in Ellar** 
 
 Authentication is an essential part of most applications. It verifies the identity of users interacting with your application. Ellar provides flexible and powerful authentication mechanisms to suit different application needs.
 
-## Overview
+## **Overview**
 
 Ellar offers two main approaches to authentication:
 
 1. **Guard Strategy** - Authentication performed at the route handler level
 2. **Authentication Handler Strategy** - Authentication performed at the middleware layer
 
-### When to Use Each Strategy
+### **When to Use Each Strategy**
 
-- **Guard Strategy**:
-  - When you need fine-grained control over authentication at the route level
-  - When authentication logic varies between different routes
-  - When you want to combine multiple authentication methods
+1. #### **Guard Strategy**:
+    - When you need fine-grained control over authentication at the route level
+    - When authentication logic varies between different routes
+    - When you want to combine multiple authentication methods
 
-- **Authentication Handler Strategy**:
-  - When you want consistent authentication across your application
-  - When authentication should happen early in the request pipeline
-  - When you need to integrate with existing authentication middleware
+2. #### **Authentication Handler Strategy**:
+    - When you want consistent authentication across your application
+    - When authentication should happen early in the request pipeline
+    - When you need to integrate with existing authentication middleware
 
-## Available Authentication Methods
+## **Available Authentication Methods**
 
 Ellar supports various authentication methods out of the box:
 
@@ -31,7 +31,7 @@ Ellar supports various authentication methods out of the box:
 - API Key Authentication (Header, Query, Cookie)
 - Custom Authentication Schemes
 
-## Getting Started
+## **Getting Started**
 
 Choose the authentication strategy that best fits your needs:
 
@@ -40,29 +40,29 @@ Choose the authentication strategy that best fits your needs:
 - [JWT Authentication Example](./jwt-authentication.md) - Complete example of JWT authentication
 - [API Key Authentication](./api-key-authentication.md) - Implement API key-based authentication
 
-## Best Practices
+## **Best Practices**
 
 1. **Security First**:
-   - Never store passwords in plain text
-   - Use secure token generation and validation
-   - Implement proper error handling
+    - Never store passwords in plain text
+    - Use secure token generation and validation
+    - Implement proper error handling
 
 2. **Performance**:
-   - Choose the appropriate authentication layer
-   - Implement caching where appropriate
-   - Consider token expiration strategies
+    - Choose the appropriate authentication layer
+    - Implement caching where appropriate
+    - Consider token expiration strategies
 
 3. **User Experience**:
-   - Implement proper token refresh mechanisms
-   - Provide clear error messages
-   - Consider rate limiting
+    - Implement proper token refresh mechanisms
+    - Provide clear error messages
+    - Consider rate limiting
 
 4. **Code Organization**:
-   - Separate authentication logic from business logic
-   - Use dependency injection for services
-   - Follow Ellar's module structure
+    - Separate authentication logic from business logic
+    - Use dependency injection for services
+    - Follow Ellar's module structure
 
-## Next Steps
+## **Next Steps**
 
 Start with the authentication strategy that best matches your requirements: