From e4aaefdb73adda4acab644100a5a3fc914aa7f51 Mon Sep 17 00:00:00 2001 From: Mukesh Kumar Chaudhary Date: Tue, 9 Jul 2024 23:03:11 +0545 Subject: [PATCH] refactor: change the header of guide section --- docs/.vitepress/config.mts | 2 +- docs/folder-structure.md | 4 ++-- docs/generate-project-config.md | 4 ++-- docs/generate-project.md | 4 ++-- docs/introduction.md | 2 +- docs/start-project.md | 6 +++--- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 9eaa859..3a05463 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -18,7 +18,7 @@ export default defineConfig({ collapsed: false, items: [ { text: "What is Geng?", link: "/introduction" }, - { text: "Getting Started.", link: "/getting-started" }, + { text: "Getting Started", link: "/getting-started" }, ], }, { diff --git a/docs/folder-structure.md b/docs/folder-structure.md index 7505f1c..96414a3 100644 --- a/docs/folder-structure.md +++ b/docs/folder-structure.md @@ -4,9 +4,9 @@ title: Start a project description: Let's learn how to execute a project using Gen-G --- -# How to use? +# Folder Structure of the project -## Folder Structure of the project +## Tree of folder structure ```bash . diff --git a/docs/generate-project-config.md b/docs/generate-project-config.md index d0fad3f..b10b756 100644 --- a/docs/generate-project-config.md +++ b/docs/generate-project-config.md @@ -4,9 +4,9 @@ title: Scaffold a project description: Let's learn how to generate a project using Gen-G --- -# How to use? +# Generate a project using config -## Generate a project using config +## Let's start Instead of using the following command. ```bash diff --git a/docs/generate-project.md b/docs/generate-project.md index 69bc838..2f5b18e 100644 --- a/docs/generate-project.md +++ b/docs/generate-project.md @@ -4,9 +4,9 @@ title: Scaffold a project description: Let's learn how to generate a project using Gen-G --- -# How to use? +# Generate a project using interactive terminal -## Generate a project +## Let's start In order to generate a project you need to enter the following command: ```bash diff --git a/docs/introduction.md b/docs/introduction.md index 3f3f795..fecf3c8 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -4,7 +4,7 @@ title: Gen-G | Generate Golang Project description: a command line tool that helps you to initialize, develop and maintain your Go gin applications --- -# What is GenG +# What is GenG? ## Introduction diff --git a/docs/start-project.md b/docs/start-project.md index 310f9f7..58bdf60 100644 --- a/docs/start-project.md +++ b/docs/start-project.md @@ -4,9 +4,9 @@ title: Start a project description: Let's learn how to execute a project using Gen-G --- -# How to use? +# Start the project -## Start the project +## Let's start In order to start a project just follow the given instruction which has been printed on project generation step. @@ -66,7 +66,7 @@ Please check https://pkg.go.dev/github.com/gin-gonic/gin#readme-don-t-trust-all- 2024-07-08T14:42:08.002Z INFO [GIN-debug] Listening and serving HTTP on :5000 ``` -### Info +### Run Once you follow all the step correctly you can see your app running at port **:5000**