diff --git a/docs/advanced-guide/gofr-errors/page.md b/docs/advanced-guide/gofr-errors/page.md index 4927e655f..0c9ee4544 100644 --- a/docs/advanced-guide/gofr-errors/page.md +++ b/docs/advanced-guide/gofr-errors/page.md @@ -12,6 +12,10 @@ automatically handle HTTP status code selection. These include: - `ErrorInvalidParam`: Represents an error due to an invalid parameter. - `ErrorMissingParam`: Represents an error due to a missing parameter. - `ErrorEntityNotFound`: Represents an error due to a not found entity. +- `ErrorEntityAlreadyExist`: Represents an error due to creation of duplicate entity. +- `ErrorInvalidRoute`: Represents an error for invalid route. +- `ErrorRequestTimeout`: Represents an error for request which timed out. +- `ErrorPanicRecovery`: Represents an error for request which panicked. #### Usage: To use the predefined http errors,users can simply call them using GoFr's http package: diff --git a/docs/advanced-guide/handling-file/page.md b/docs/advanced-guide/handling-file/page.md index 3999d0070..689106d91 100644 --- a/docs/advanced-guide/handling-file/page.md +++ b/docs/advanced-guide/handling-file/page.md @@ -1,6 +1,6 @@ # Handling File -Gofr simplifies the complexity of working with different filestores by offering a uniform API. This allows developers to interact with different storage systems using the same set of methods, without needing to understand the underlying implementation details of each filestore. +GoFr simplifies the complexity of working with different file stores by offering a uniform API. This allows developers to interact with different storage systems using the same set of methods, without needing to understand the underlying implementation details of each file store. ## USAGE @@ -82,4 +82,4 @@ err := c.File.RemoveAll("my_dir/my_text") ``` -> Errors have been skipped in the example to focus on the core logic, it is recommended to handle all the errors. \ No newline at end of file +> Errors have been skipped in the example to focus on the core logic, it is recommended to handle all the errors. diff --git a/docs/advanced-guide/overriding-default/page.md b/docs/advanced-guide/overriding-default/page.md index 5c14194c6..9ede5d258 100644 --- a/docs/advanced-guide/overriding-default/page.md +++ b/docs/advanced-guide/overriding-default/page.md @@ -74,7 +74,7 @@ Response example: ## Favicon.ico -By default GoFr load its own `favicon.ico` present in root directory for an application. To override `favicon.ico` user +By default, GoFr load its own `favicon.ico` present in root directory for an application. To override `favicon.ico` user can place its custom icon in the **static** directory of its application. -> NOTE: The custom favicon should also be named as `favicon.ico` in the static directory of application. \ No newline at end of file +> NOTE: The custom favicon should also be named as `favicon.ico` in the static directory of application. diff --git a/docs/advanced-guide/swagger-documentation/page.md b/docs/advanced-guide/swagger-documentation/page.md index 2d47d330d..d6bd04b0b 100644 --- a/docs/advanced-guide/swagger-documentation/page.md +++ b/docs/advanced-guide/swagger-documentation/page.md @@ -23,7 +23,7 @@ GoFr will automatically render the Swagger documentation at the `/.well-known/sw Here are the steps: - Create an `openapi.json` file that describes your API according to the OpenAPI specification. -- Place the `openapi.json` file inside the static directory in your project. +- Place the `openapi.json` file inside the `static` directory in your project. - Start your GoFr server. - Navigate to `/.well-known/swagger` on your server’s URL. diff --git a/docs/quick-start/configuration/page.md b/docs/quick-start/configuration/page.md index a4ac7c53e..5369cbe87 100644 --- a/docs/quick-start/configuration/page.md +++ b/docs/quick-start/configuration/page.md @@ -2,7 +2,7 @@ GoFr simplifies configuration management by reading configuration via environment variables. Application code is decoupled from how configuration is managed as per the {%new-tab-link title="12-factor" href="https://12factor.net/config" %}. -Configs in GoFr can be used to initialise datasources, tracing , setting log levels, changing default HTTP or metrics port. +Configs in GoFr can be used to initialise datasources, tracing, setting log levels, changing default HTTP or metrics port. This abstraction provides a user-friendly interface for configuring user's application without modifying the code itself. To set configs create a `configs` directory in the project's root and add `.env` file. @@ -44,4 +44,4 @@ APP_ENV=dev go run main.go ``` -This approach ensures that the correct configurations are used for each environment, providing flexibility and control over the application's behavior in different contexts. \ No newline at end of file +This approach ensures that the correct configurations are used for each environment, providing flexibility and control over the application's behavior in different contexts. diff --git a/docs/quick-start/connecting-mysql/page.md b/docs/quick-start/connecting-mysql/page.md index 990184cfa..b6043eb5c 100644 --- a/docs/quick-start/connecting-mysql/page.md +++ b/docs/quick-start/connecting-mysql/page.md @@ -4,7 +4,7 @@ Just like Redis GoFr also supports connection to SQL(MySQL and Postgres) databas ## Setup -Users can run MySQL and create a database locally using the following docker command: +Users can run MySQL and create a database locally using the following Docker command: ```bash docker run --name gofr-mysql -e MYSQL_ROOT_PASSWORD=root123 -e MYSQL_DATABASE=test_db -p 3306:3306 -d mysql:8.0.30 diff --git a/docs/quick-start/observability/page.md b/docs/quick-start/observability/page.md index c99a2d14f..95d9b919f 100644 --- a/docs/quick-start/observability/page.md +++ b/docs/quick-start/observability/page.md @@ -166,7 +166,7 @@ a request as it travels through your distributed system by simply looking at the GoFr has support for following trace-exporters: #### 1. [Zipkin](https://zipkin.io/): -To see the traces install zipkin image using the following docker command: +To see the traces install zipkin image using the following Docker command: ```bash docker run --name gofr-zipkin -p 2005:9411 -d openzipkin/zipkin:latest @@ -188,7 +188,7 @@ DB_NAME=test_db DB_PORT=3306 # tracing configs -TRACE_EXPORTER=zipkin +TRACE_EXPORTER=zipkin TRACER_HOST=localhost TRACER_PORT=2005 @@ -203,7 +203,7 @@ Open {% new-tab-link title="zipkin" href="http://localhost:2005/zipkin/" /%} and #### 2. [Jaeger](https://www.jaegertracing.io/): -To see the traces install jaeger image using the following docker command: +To see the traces install jaeger image using the following Docker command: ```bash docker run -d --name jaeger \ @@ -227,7 +227,7 @@ TRACER_PORT=14317 Open {% new-tab-link title="zipkin" href="http://localhost:16686/trace/" /%} and search by TraceID (correlationID) to see the trace. {% figure src="/jaeger-traces.png" alt="Jaeger traces" /%} -#### 3. [GoFr Tracer](https://tracer.gofr.dev/) +#### 3. [GoFr Tracer](https://tracer.gofr.dev/): GoFr tracer is GoFr's own custom trace exporter as well as collector. You can search a trace by its TraceID (correlationID) in GoFr's own tracer service available anywhere, anytime. diff --git a/docs/references/configs/page.md b/docs/references/configs/page.md index 8ad35d4f1..4f0f12175 100644 --- a/docs/references/configs/page.md +++ b/docs/references/configs/page.md @@ -1,6 +1,6 @@ # GoFr Configuration Options -This document lists all the configuration options supported by the Gofr framework. The configurations are grouped by category for better organization. +This document lists all the configuration options supported by the GoFr framework. The configurations are grouped by category for better organization. ## App @@ -301,4 +301,3 @@ This document lists all the configuration options supported by the Gofr framewor - Quality of Service Level {% /table %} - diff --git a/docs/references/context/page.md b/docs/references/context/page.md index 30dbf2268..aff1923e1 100644 --- a/docs/references/context/page.md +++ b/docs/references/context/page.md @@ -3,7 +3,7 @@ GoFr context is an object injected by the GoFr handler. It contains all the requ request-response cycle a new context is created. The request can be either an HTTP request, GRPC call or a message from Pub-Sub. GoFr Context also embeds the **_container_** which maintains all the dependencies like databases, logger, HTTP service clients, -, metrics manager, etc. This reduces the complexity of the application as users don't have to maintain and keep track of +metrics manager, etc. This reduces the complexity of the application as users don't have to maintain and keep track of all the dependencies by themselves. GoFr context is an extension of the go context, providing a wrapper around the request and response providing