Update vitepress to v1.0.1; Add project structure info

gowebly · Mar 23, 2024 · 269fa62 · 269fa62
1 parent 12ab1dc
commit 269fa62
Show file tree

Hide file tree

Showing 12 changed files with 63 additions and 20 deletions.
diff --git a/.gitignore b/.gitignore
@@ -14,7 +14,6 @@
 
 # Node modules
 node_modules/
-bun.lockb
 
 # Temp directories
 docs/.vitepress/cache/

diff --git a/bun.lockb b/bun.lockb
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -4,8 +4,8 @@ import { withMermaid } from 'vitepress-plugin-mermaid'
 // Define user configuration.
 const userConfig: UserConfig = {
   title: 'Gowebly',
-  titleTemplate: 'A next-generation CLI tool for easily build amazing web apps with Go, htmx & hyperscript ~ Gowebly',
-  description: 'A next-generation CLI tool for easily build amazing web applications with Go on the backend, using htmx & hyperscript and the most popular atomic/utility-first CSS frameworks on the frontend.',
+  titleTemplate: 'A next-generation CLI tool for easily build amazing web apps with Go, Templ, htmx, hyperscript or Alpine.js and CSS frameworks ~ Gowebly',
+  description: 'A next-generation CLI tool that makes it easy to create amazing web applications with Go on the backend, using htmx, hyperscript or Alpine.js and the most popular CSS frameworks on the frontend.',
   lastUpdated: true,
   cleanUrls: true,
   mermaid: {

diff --git a/docs/complete-user-guide/create-new-project.md b/docs/complete-user-guide/create-new-project.md
@@ -18,6 +18,17 @@ And result will be:
 
 Typically, the created project contains the following files and folders:
 
+- The templates are located in the `./templates` folder.
+- The main CSS file `styles.scss` is located in the `./assets` folder.
+- The main JavaScript file `scripts.js` is located in the `./assets` folder.
+- The PWA manifest file `manifest.json` and images are located in the `./static` folder.
+
+::: warning Go structure disclaimer
+Please note, that the **Gowebly** does not impose any restrictions on the architecture, style or structure of your project. The CLI only helps you **quickly start a new project** and generates all the necessary files for you.
+
+Therefore, you are **free to create** any project structure you wish.
+:::
+
 ::: code-group
 ```bash{18,19} [Using html/template]
 .

diff --git a/docs/complete-user-guide/info-about-system.md b/docs/complete-user-guide/info-about-system.md
@@ -20,11 +20,11 @@ And result will be:
 │
 │ Copy this information to paste into an issue ↘
 │
-│ Gowebly CLI: v2.0.1 (build with go1.21.5 on darwin/arm64)
+│ Gowebly CLI: v2.3.3 (build with go1.22.1 on darwin/arm64)
 │
-│ Go: 1.21.5 darwin/arm64
-│ Node.js version: 21.5.0 (npm 10.2.4)
-│ Bun version: 1.0.21
+│ Go: 1.22.1 darwin/arm64
+│ Node.js version: 21.7.1 (npm 10.5.0)
+│ Bun version: 1.0.35
 │
 │ Is Air tool installed? true
 │ Is Templ package installed? true

diff --git a/docs/es/complete-user-guide/create-new-project.md b/docs/es/complete-user-guide/create-new-project.md
@@ -18,6 +18,17 @@ And result will be:
 
 Typically, the created project contains the following files and folders:
 
+- The templates are located in the `./templates` folder.
+- The main CSS file `styles.scss` is located in the `./assets` folder.
+- The main JavaScript file `scripts.js` is located in the `./assets` folder.
+- The PWA manifest file `manifest.json` and images are located in the `./static` folder.
+
+::: warning Go structure disclaimer
+Please note, that the **Gowebly** does not impose any restrictions on the architecture, style or structure of your project. The CLI only helps you **quickly start a new project** and generates all the necessary files for you.
+
+Therefore, you are **free to create** any project structure you wish.
+:::
+
 ::: code-group
 ```bash{18,19} [Using html/template]
 .

diff --git a/docs/es/complete-user-guide/info-about-system.md b/docs/es/complete-user-guide/info-about-system.md
@@ -20,11 +20,11 @@ And result will be:
 │
 │ Copy this information to paste into an issue ↘
 │
-│ Gowebly CLI: v2.0.1 (build with go1.21.5 on darwin/arm64)
+│ Gowebly CLI: v2.3.3 (build with go1.22.1 on darwin/arm64)
 │
-│ Go: 1.21.5 darwin/arm64
-│ Node.js version: 21.5.0 (npm 10.2.4)
-│ Bun version: 1.0.21
+│ Go: 1.22.1 darwin/arm64
+│ Node.js version: 21.7.1 (npm 10.5.0)
+│ Bun version: 1.0.35
 │
 │ Is Air tool installed? true
 │ Is Templ package installed? true

diff --git a/docs/ru/complete-user-guide/create-new-project.md b/docs/ru/complete-user-guide/create-new-project.md
@@ -18,6 +18,17 @@ And result will be:
 
 Typically, the created project contains the following files and folders:
 
+- The templates are located in the `./templates` folder.
+- The main CSS file `styles.scss` is located in the `./assets` folder.
+- The main JavaScript file `scripts.js` is located in the `./assets` folder.
+- The PWA manifest file `manifest.json` and images are located in the `./static` folder.
+
+::: warning Go structure disclaimer
+Please note, that the **Gowebly** does not impose any restrictions on the architecture, style or structure of your project. The CLI only helps you **quickly start a new project** and generates all the necessary files for you.
+
+Therefore, you are **free to create** any project structure you wish.
+:::
+
 ::: code-group
 ```bash{18,19} [Using html/template]
 .

diff --git a/docs/ru/complete-user-guide/info-about-system.md b/docs/ru/complete-user-guide/info-about-system.md
@@ -20,11 +20,11 @@ And result will be:
 │
 │ Copy this information to paste into an issue ↘
 │
-│ Gowebly CLI: v2.0.1 (build with go1.21.5 on darwin/arm64)
+│ Gowebly CLI: v2.3.3 (build with go1.22.1 on darwin/arm64)
 │
-│ Go: 1.21.5 darwin/arm64
-│ Node.js version: 21.5.0 (npm 10.2.4)
-│ Bun version: 1.0.21
+│ Go: 1.22.1 darwin/arm64
+│ Node.js version: 21.7.1 (npm 10.5.0)
+│ Bun version: 1.0.35
 │
 │ Is Air tool installed? true
 │ Is Templ package installed? true

diff --git a/docs/zh_HK/complete-user-guide/create-new-project.md b/docs/zh_HK/complete-user-guide/create-new-project.md
@@ -18,6 +18,17 @@ And result will be:
 
 Typically, the created project contains the following files and folders:
 
+- The templates are located in the `./templates` folder.
+- The main CSS file `styles.scss` is located in the `./assets` folder.
+- The main JavaScript file `scripts.js` is located in the `./assets` folder.
+- The PWA manifest file `manifest.json` and images are located in the `./static` folder.
+
+::: warning Go structure disclaimer
+Please note, that the **Gowebly** does not impose any restrictions on the architecture, style or structure of your project. The CLI only helps you **quickly start a new project** and generates all the necessary files for you.
+
+Therefore, you are **free to create** any project structure you wish.
+:::
+
 ::: code-group
 ```bash{18,19} [Using html/template]
 .

diff --git a/docs/zh_HK/complete-user-guide/info-about-system.md b/docs/zh_HK/complete-user-guide/info-about-system.md
@@ -20,11 +20,11 @@ And result will be:
 │
 │ Copy this information to paste into an issue ↘
 │
-│ Gowebly CLI: v2.0.1 (build with go1.21.5 on darwin/arm64)
+│ Gowebly CLI: v2.3.3 (build with go1.22.1 on darwin/arm64)
 │
-│ Go: 1.21.5 darwin/arm64
-│ Node.js version: 21.5.0 (npm 10.2.4)
-│ Bun version: 1.0.21
+│ Go: 1.22.1 darwin/arm64
+│ Node.js version: 21.7.1 (npm 10.5.0)
+│ Bun version: 1.0.35
 │
 │ Is Air tool installed? true
 │ Is Templ package installed? true

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "gowebly-docs",
   "description": "Documentation for the Gowebly project.",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "license": "Apache-2.0",
   "scripts": {
     "dev": "vitepress dev docs",