From 45255e73aab75f08c0cd34f32e5a1118a30a722f Mon Sep 17 00:00:00 2001 From: symball Date: Sun, 12 Apr 2026 15:50:43 +0800 Subject: [PATCH] Docs: Add project structure page * Rework command initiation to use cobra / viper * abstract init builder away from command package --- .../docs/guides/dev/project-structure.mdx | 42 +++++++++++++++++++ v3/UNRELEASED_CHANGELOG.md | 2 +- 2 files changed, 43 insertions(+), 1 deletion(-) create mode 100644 docs/src/content/docs/guides/dev/project-structure.mdx diff --git a/docs/src/content/docs/guides/dev/project-structure.mdx b/docs/src/content/docs/guides/dev/project-structure.mdx new file mode 100644 index 00000000000..bc9f51787e0 --- /dev/null +++ b/docs/src/content/docs/guides/dev/project-structure.mdx @@ -0,0 +1,42 @@ +--- +title: Project Structure +description: Understand the file layout for a typical Wails project +sidebar: + order: 1 +--- + +This page is a simple reference to the files created when you initiate a new project using the Vanilla template + +``` +/ +├── main.go # Application entry point +├── greetservice.go # Example backend service exposed to frontend +├── go.mod # Go module definition +├── config.yml # Wails/project configuration +├── Taskfile.yml # Task runner for dev/build commands +├── build/ # Packaging and platform-specific assets +│ ├── appicon.png # Default app icon +│ ├── appicon.icon/ # Icon source files +│ ├── darwin/ # macOS build config +│ ├── windows/ # Windows build config +│ ├── linux/ # Linux build config +│ ├── android/ # Android build config +│ ├── ios/ # iOS build config +│ └── docker/ # Containerized build environment +├── frontend/ # Frontend (Vite + React + TS) +│ ├── index.html # HTML entry point +│ ├── src/ +│ │ └── main.js # Frontend bootstrap +│ ├── public/ # Static assets +│ ├── dist/ # Built frontend output +│ ├── bindings/ # Auto-generated Go bindings +│ ├── package.json # Frontend dependencies +│ ├── vite.config.ts # Vite configuration +│ └── tsconfig.json # TypeScript configuration +├── bin/ # Compiled binaries +└── .task/ # Task runner cache + ``` + +:::note[Frontend project files] +If you choose to use a different starter template, contents of `frontend/src` will differ depending on your chosen framework +::: \ No newline at end of file diff --git a/v3/UNRELEASED_CHANGELOG.md b/v3/UNRELEASED_CHANGELOG.md index 8e46480384f..816e935242c 100644 --- a/v3/UNRELEASED_CHANGELOG.md +++ b/v3/UNRELEASED_CHANGELOG.md @@ -16,7 +16,7 @@ After processing, the content will be moved to the main changelog and this file --> ## Added - +- Added missing project structure page ## Changed