Refactor Docs (#334)

---------

Co-authored-by: umang01-hash <[email protected]>

Author: aryanmehrotra

docs/advanced-guide/custom-spans-in-tracing/page.md

@@ -13,13 +13,11 @@ By adding custom spans in traces to your requests, you can:
 - **Improve debugging:** Custom spans enhance your ability to debug issues by providing visibility into the execution 
       flow of your application.
 
-## Adding Custom Spans:
+## Usage
 
 To add a custom trace to a request, you can use the `Trace()` method of GoFr context, which takes the name of the span as an argument 
 and returns a trace.Span. 
 
-### Usage
-
 ```go
 func MyHandler(c context.Context) error {
     span := c.Trace("my-custom-span")

docs/advanced-guide/interservice-http-call/page.md renamed to docs/advanced-guide/http-communication/page.md

@@ -1,12 +1,12 @@
 # Interservice HTTP Calls
-GoFr promotes microservice architechure and to facilitate the same, it provides the support
+GoFr promotes microservice architecture and to facilitate the same, it provides the support
 to initialize HTTP services at application level using `AddHTTPService()` method.
 Support for inter-service http calls provide the following benefits:
 
 1. Access to the method from container - GET, PUT, POST, PATCH, DELETE.
 2. Logs and traces for the request.
-3. Circuit breaking for enhanced resilience and fault tolerance.
-4. Custom Health Check Endpoints
+3. [Circuit breaking](/docs/advanced-guide/circuit-breaker) for enhanced resilience and fault tolerance.
+4. [Custom Health Check](/docs/advanced-guide/monitoring-service-health) Endpoints
 
 ## Usage
 

docs/advanced-guide/monitoring-service-health/page.md

@@ -1,9 +1,9 @@
 # Monitoring Service Health
+Health check in microservices refers to a mechanism or process implemented within each service to assess its operational status and readiness to handle requests. It involves regularly querying the service to determine if it is functioning correctly, typically by evaluating its responsiveness and ability to perform essential tasks. Health checks play a critical role in ensuring service availability, detecting failures, preventing cascading issues, and facilitating effective traffic routing in distributed systems.
 
-As there can be multiple service, they need to be checked if they are UP or not.
-GoFr registers two endpoints by default which are :
+## GoFr by default registers two endpoints which are :
 
-1. Aliveness - /.well-known/alive
+### 1. Aliveness - /.well-known/alive
 
 It is an endpoint which return the following response when the service is UP with a 200 response code.
 ```json
@@ -24,7 +24,7 @@ To override the endpoint when registering HTTP Service pass the following option
 		}
 ```
 
-2. Health-Check - /.well-known/health-check
+### 2. Health-Check - /.well-known/health-check
 
 It returns if the service is UP or DOWN along with stats, host, status about the dependent datasources and services.
 

docs/advanced-guide/publishing-custom-metrics/page.md

@@ -1,16 +1,17 @@
 # Publishing Custom Metrics
 
 For GoFr default metrics refer: [observability](/docs/quick-start/observability).
-If there is a requirement of a metric other than the GoFr defaults, you can create them using custom metrics as shown below.
 
-GoFr supports the following [metric](https://opentelemetry.io/docs/specs/otel/metrics/) types in prometheus format:
+GoFr can handle multiple different metrics concurrently, each uniquely identified by its name during initialization.
+It supports the following [metrics](https://opentelemetry.io/docs/specs/otel/metrics/) types in prometheus format:
 
 1. Counter
 2. UpDownCounter
 3. Histogram
 4. Gauge
 
-GoFr is capable of handling multiple Counter, UpDownCounter, Histogram, and Gauge metrics concurrently, each uniquely identified by its name during initialization.
+If any metric other than defaults provided, you can create them using custom metrics as shown below.
+
 
 ## Usage
 
@@ -136,3 +137,18 @@ func main() {
 	app.Run()
 }
 ```
+
+**Good To Know**
+```doc
+While registering a metrics two key pieces of information of required
+- Name
+- Description
+   
+When a registered Metrics has to be used 3 key pieces of information are required:
+- Metrics name
+- Value
+- A set of key-value pairs called tags or labels.
+
+A permutation of these key-value values provides the metric cardinality.
+Lower the cardinality, faster the query performance and lower the monitoring resource utilisation.
+```

docs/advanced-guide/remote-log-level-change/page.md

@@ -1,16 +1,19 @@
 # Remote Log Level Change
-Gofr makes it easy to adjust the detail captured in your application's logs, even while it's running! This feature empowers 
-users to effortlessly fine-tune logging levels without the need for redeployment, enhancing the monitoring and debugging experience.
-This feature is facilitated through simple configuration settings.
+Gofr makes it easy to adjust the detail captured in your application's logs, even while it's running! 
 
-## Why it is important?
-- **Effortless Adjustments:** Modify the level of detail in your logs anytime without restarting your application. 
-    This is especially helpful during troubleshooting or when log volume needs to be adjusted based on the situation.
-- **Enhanced Visibility:** Easily switch to a more detailed log level (e.g., `DEBUG`) to gain deeper insights into specific issues, 
-                       and then switch back to a less detailed level (e.g., `INFO`) for regular operation.
+This feature allows users to effortlessly fine-tune logging levels without the need for redeployment, enhancing the monitoring and debugging experience.
+It is facilitated through simple configuration settings.
+
+## How it helps?
+  - **Effortless Adjustments:** Modify the level of detail in your logs anytime without restarting your application. 
+ This is especially helpful during troubleshooting.
+  - **Enhanced Visibility:** Easily switch to a more detailed log level (e.g., `DEBUG`) to gain deeper insights into specific issues, 
+    and then switch back to a less detailed level (e.g., `INFO`) for regular operation.
+  - **Improved Performance:** Generating a large number of logs can overwhelm the logging system, leading to increased I/O operations and resource consumption,
+  changing to Warn or Error Level reduces the number of logs, and enhancing performance.
 
 ## Configuration
-To enable remote log level updating, users need to specify the following configuration parameter:
+To enable remote log level update, users need to specify the following configuration parameter:
 
 ```dotenv
 REMOTE_LOG_URL=<URL to your remote log level endpoint> (e.g., https://your-service.com/log-levels)
@@ -40,7 +43,7 @@ The remote log level endpoint should return a JSON response in the following for
 - **logLevel:** The new log level you want to set for the specified service.
 
 
-GoFr parses this response and dynamically adjusts log levels according to the provided configurations.
+GoFr parses this response and adjusts log levels based on the provided configurations.
 
 
 

docs/navigation.js

@@ -12,15 +12,15 @@ export const navigation = [
     {
         title: 'Advanced Guide',
         links: [
-            { title: 'Inter-service HTTP Calls', href: '/docs/advanced-guide/interservice-http-call' },
             { title: 'Publishing Custom Metrics', href: '/docs/advanced-guide/publishing-custom-metrics' },
             { title: 'Remote Log Level Change', href: '/docs/advanced-guide/remote-log-level-change' },
             { title: 'Handling Data Migrations', href: '/docs/advanced-guide/handling-data-migrations' },
-            // { title: 'Dealing with Remote Files', href: '/docs/advanced-guide/remote-files' },
-            { title: 'Monitoring Service Health', href: '/docs/advanced-guide/monitoring-service-health' },
-            // { title: 'Supporting OAuth', href: '/docs/advanced-guide/oauth' },
+            { title: 'HTTP Communication', href: '/docs/advanced-guide/http-communication' },
             { title: 'Circuit Breaker Support', href: '/docs/advanced-guide/circuit-breaker' },
+            { title: 'Monitoring Service Health', href: '/docs/advanced-guide/monitoring-service-health' },
             { title: 'Custom Spans in Tracning', href: '/docs/advanced-guide/custom-spans-in-tracing' },
+            // { title: 'Dealing with Remote Files', href: '/docs/advanced-guide/remote-files' },
+            // { title: 'Supporting OAuth', href: '/docs/advanced-guide/oauth' },
             // { title: 'Writing gRPC Server', href: '/docs/advanced-guide/grpc' },
             // { title: 'Creating a Static File Server', href: '/docs/advanced-guide/static-file-server' },
             // { title: 'WebSockets', href: '/docs/advanced-guide/websockets' },

docs/quick-start/configuration/page.md

@@ -4,7 +4,7 @@ GoFr reads configuration via environment variables. It provides an easy way to m
 
 Configs in GoFr can be used to initialise datasources, tracing. In doing so it abstract the logic and gives an easy interface to setup different things.
 
-To set configs create a `configs` folder in the project's root and add `.env` file.
+To set configs create a `configs` directory in the project's root and add `.env` file.
 
 By default, GoFr starts HTTP server at port 8000, in order to change that we can add the config `HTTP_PORT`
 Similarly to Set the app-name you can add `APP_NAME`. For example:

docs/quick-start/connecting-mysql/page.md

@@ -1,6 +1,6 @@
 # Connecting MySQL
 
-Just like any other datasource gofr also supports connection to MySQL database based on configuration variables.
+Just like Redis gofr also supports connection to SQL(mysql and postgres) databases based on configuration variables.
 
 ## Setup
 
@@ -16,7 +16,7 @@ Access `test_db` database and create table customer with columns `id` and `name`
 docker exec -it gofr-mysql mysql -uroot -proot123 test_db -e "CREATE TABLE customers (id INT AUTO_INCREMENT PRIMARY KEY, name VARCHAR(255) NOT NULL);"
 ```
 
-Now the database with table is ready, we can connect our server to MySQL
+Now the database with table is ready, we can connect our GoFr server to MySQL
 
 ## Configuration & Usage
 

docs/quick-start/connecting-redis/page.md

@@ -15,7 +15,7 @@ To set a sample key, run the following command:
 docker exec -it gofr-redis bash -c 'redis-cli SET greeting "Hello from Redis."'
 ```
 
-## Using Redis in GoFr
+## Configuration & Usage
 
 GoFr requires certain configurations to connect to Redis. The necessary configurations include 
 `REDIS_HOST`and `REDIS_PORT`. Update the `.env` file in the configs directory with the following content:
@@ -28,7 +28,7 @@ REDIS_HOST=localhost
 REDIS_PORT=6379
 ```
 
-Once the Redis configurations are set, you can utilize Redis in your GoFr application. 
+Once the Redis configurations are set, you can use Redis in your GoFr application. 
 Below is an example of how to retrieve data from Redis in the `main.go` file:
 
 ```golang

docs/quick-start/introduction/page.md

@@ -1,10 +1,9 @@
 # Prerequisite
 
-- Install or update [Go](https://go.dev/dl/).
+-  Go 1.19 or above.
+   To check the version use the following command `go version`.
 
-  To check the version use the following command `go version`.
-
-- Prior familiarity with Golang syntax is essential. [Golang Tour](https://tour.golang.org/) is highly recommended as it has an excellent guided tour.
+-  Prior familiarity with Golang syntax is essential. [Golang Tour](https://tour.golang.org/) is highly recommended as it has an excellent guided tour.
 
 ## Write your first GoFr API
 
@@ -45,7 +44,7 @@ func main() {
 }
 ```
 
-Before running the server run the following command to go needs to download and sync the required modules.
+Before running the server run the following go command to download and sync the required modules.
 
 `go mod tidy`
 
@@ -69,20 +68,22 @@ The `hello-world` server involves three essential steps:
 
    _This single line is a standard part of all gofr-based servers._
 
+
 2. **Attaching a Handler to a Path:**
 
    In this step, we instruct the server to associate an HTTP request with a specific handler function. This is achieved through `app.GET("/greet", HandlerFunction)`, where _GET /hello_ maps to HandlerFunction. Likewise, `app.POST("/todo", ToDoCreationHandler)` links a _POST_ request to the /todo endpoint with _ToDoCreationHandler_.
 
+
    **Good To Know**
 
-   In Go, functions are first-class citizens, allowing easy handler definition and reference.
-   Handler functions should follow the `func(ctx *gofr.Context) (interface{}, error)` signature.
-   They take a context as input, returning two values: the response data and an error (set to `nil` on success).
+>  In Go, functions are first-class citizens, allowing easy handler definition and reference.
+   HTTP Handler functions should follow the `func(ctx *gofr.Context) (interface{}, error)` signature.
+   They take a context as input, returning two values: the response data and an error (set to `nil` when there is no error).
 
    In GoFr `ctx *gofr.Context` serves as a wrapper for requests, responses, and dependencies, providing various functionalities.
 
-   For more details about context, refer [here](/docs/v1/references/context).
+   For more details about context, refer [here](/docs/references/context).
 
 3. **Starting the server**
 
-   When `app.Run()` is called, it configures ,initiates and runs the HTTP server, middlewares based on provided configs. It manages essential features such as routes for health checks, swagger UI etc. It starts the server on the default port 8000.
+   When `app.Run()` is called, it configures ,initiates and runs the HTTP server, middlewares. It manages essential features such as routes for health check endpoints, metrics server, favicon etc. It starts the server on the default port 8000.